Skip to content

[RNE Rewrite] docs(jsdoc): streamline and align typescript API comments with native code#1272

Merged
barhanc merged 1 commit into
rne-rewritefrom
@bh/streamline-jsdoc
Jun 20, 2026
Merged

[RNE Rewrite] docs(jsdoc): streamline and align typescript API comments with native code#1272
barhanc merged 1 commit into
rne-rewritefrom
@bh/streamline-jsdoc

Conversation

@barhanc

@barhanc barhanc commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Description

Streamlines the library's JSDoc comments to improve documentation readability, eliminate verbosity, and correct accuracy discrepancies with C++ ExecuTorch runtime bindings.

Introduces a breaking change?

  • Yes
  • No

Type of change

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Documentation update (improves or adds clarity to existing documentation)
  • Other (chores, tests, code style improvements etc.)

Tested on

  • iOS
  • Android

Testing instructions

N/A

Screenshots

Related issues

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

Additional notes

@barhanc barhanc self-assigned this Jun 20, 2026
@barhanc barhanc added the documentation Improvements or additions to documentation label Jun 20, 2026
@barhanc barhanc changed the title docs(jsdoc): streamline and align typescript API comments with native code [RNE Rewrite] docs(jsdoc): streamline and align typescript API comments with native code Jun 20, 2026

@msluszniak msluszniak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@barhanc barhanc merged commit ba7061f into rne-rewrite Jun 20, 2026
2 checks passed
@barhanc barhanc deleted the @bh/streamline-jsdoc branch June 20, 2026 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants