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

Export all types that are referenced by all exported types #686

Closed
Tracked by #806
thehenrytsai opened this issue Feb 12, 2024 · 2 comments · Fixed by #822
Closed
Tracked by #806

Export all types that are referenced by all exported types #686

thehenrytsai opened this issue Feb 12, 2024 · 2 comments · Fixed by #822
Assignees
@aniketh-varma
Labels
CICD CICD related item documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest For the hacking month of October

Comments

@thehenrytsai
Copy link
Member

thehenrytsai commented Feb 12, 2024 •
edited
Loading

Currently there are types referenced by exported types that are not explicitly exported which is not friendly for developers from documentation point of view.

Run npx typedoc --validation --entryPoints src/index.ts agains the repo and look for:

[warning]... defined in... but not included in the documentation

And remove all those instances by exporting the type referenced.
@thehenrytsai thehenrytsai added the good first issue Good for newcomers label Feb 12, 2024
@thehenrytsai thehenrytsai added hacktoberfest For the hacking month of October documentation Improvements or additions to documentation CICD CICD related item labels Sep 13, 2024
@taniashiba taniashiba mentioned this issue Sep 23, 2024
Open
19 tasks
@aniketh-varma
Copy link
Contributor

.take

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 4, 2024

Thanks for taking this issue! Let us know if you have any questions!

@aniketh-varma aniketh-varma mentioned this issue Oct 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aniketh-varma aniketh-varma

Labels
CICD CICD related item documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest For the hacking month of October
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Explicitly export types not referenced by exported types aniketh-varma/dwn-sdk-js
2 participants
@thehenrytsai @aniketh-varma