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

Missing JSDoc #102

Closed
clementbiron opened this issue Nov 30, 2023 · 4 comments · Fixed by OpenTermsArchive/engine#1043
Closed

Missing JSDoc #102

clementbiron opened this issue Nov 30, 2023 · 4 comments · Fixed by OpenTermsArchive/engine#1043

Comments

@clementbiron
Copy link
Member

We write that fetch and extract have a JSDoc, but we can't find any information in the JSDoc about this functions.

It's a bit strange because these functions are well commented in the code.
@Ndpnt Ndpnt mentioned this issue Feb 8, 2024
Merged
@MattiSG
Copy link
Member

MattiSG commented Feb 8, 2024

This issue is closed but I still can't see these functions in the JSDoc.

@MattiSG MattiSG reopened this Feb 8, 2024
@MattiSG
Copy link
Member

MattiSG commented Feb 8, 2024

It would be welcome to add an automated test on the generated doc to avoid this happening again in the future 🙂

@clementbiron
Copy link
Member Author

It's because the JSDoc is generated when there is a new release of the engine and there haven't been any since.

@clementbiron
Copy link
Member Author

There has been a release and the jsdoc has been generated, see fetch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ensure that the documentation for exposed functions is generated using JSDoc OpenTermsArchive/engine
2 participants
@MattiSG @clementbiron