Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Review and update type visibility and documentation #103

Closed
4 tasks
aryaemami59 opened this issue Aug 15, 2024 · 0 comments · Fixed by #104
Closed
4 tasks

Review and update type visibility and documentation #103

aryaemami59 opened this issue Aug 15, 2024 · 0 comments · Fixed by #104
Assignees
@aryaemami59
Labels
chore Does not impact code behavior documentation Improvements or additions to documentation
Milestone
1.0.0

Comments

@aryaemami59
Copy link
Collaborator

  • Review all type definitions to determine which should be publicly exported and which should remain internal to the module.
  • Use @internal JSDoc tags to clearly indicate types that are intended for internal use only.
  • Remove unused/obsolete types.
  • Consider marking exported types with @public JSDoc tags to align with the documentation standards recommended by api-extractor.
@aryaemami59 aryaemami59 added documentation Improvements or additions to documentation chore Does not impact code behavior labels Aug 15, 2024
@aryaemami59 aryaemami59 added this to the 1.0.0 milestone Aug 15, 2024
@aryaemami59 aryaemami59 self-assigned this Aug 15, 2024
@aryaemami59 aryaemami59 mentioned this issue Aug 15, 2024
Merged
2 tasks
aryaemami59 added a commit that referenced this issue Aug 15, 2024
@aryaemami59
Mark internal APIs with @internal JSDoc tag (#104)
4c40b07 
## **This PR**:

- [X] Marks internal APIs with `@internal` JSDoc tag.
- [X] Resolves #103.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aryaemami59 aryaemami59

Labels
chore Does not impact code behavior documentation Improvements or additions to documentation
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

Mark internal APIs with @internal JSDoc tag aryaemami59/expect-type
1 participant
@aryaemami59