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.

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

Fix papi.d.ts not showing some JSDoc comments #166

Closed
tjcouch-sil opened this issue May 1, 2023 · 1 comment · Fixed by #288
Closed

Fix papi.d.ts not showing some JSDoc comments #166

tjcouch-sil opened this issue May 1, 2023 · 1 comment · Fixed by #288
Assignees

Comments

@tjcouch-sil
Copy link
Member

tjcouch-sil commented May 1, 2023

Fix imports in papi so you can actually see comments and such instead of individually setting types on things like dataProvider.

This is important because, at the current moment, extensions see very few comments when they are using intellisense on papi. For example, you can see a function signature but no JSDoc comments on papi.dataProvider.get. This will severely impact extension developers' ability to write extensions easily:
image

Note you can make jsdocs inherit from parent classes or interfaces and such with /** @inheritDoc **/ apparently! Not sure how relevant that is to this particular issue.

@tjcouch-sil
Copy link
Member Author

Split off the bullet "Remove internal-only dependencies that are not actually used anywhere on the papi (ex: node/services/node-file-system.service)" into #175

@tjcouch-sil tjcouch-sil changed the title Improve papi.d.ts generation Fix papi.d.ts not showing some JSDoc comments May 10, 2023
@lyonsil lyonsil self-assigned this Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants