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

Fix missing JSdoc #811

Closed
peterpeterparker opened this issue Dec 11, 2023 · 1 comment · Fixed by #819
Closed

Fix missing JSdoc #811

peterpeterparker opened this issue Dec 11, 2023 · 1 comment · Fixed by #819

Comments

@peterpeterparker
Copy link
Member

Is your feature request related to a problem? Please describe.

PR changes are hard to read because of repeated warning regarding the missing documentation.

Check warning on line 1535 in packages/candid/src/idl.ts
GitHub Actions / test (8.8.4, release-0.16, 20)

Missing JSDoc @param "x" description

Capture d’écran 2023-12-11 à 08 48 52

Describe the solution you'd like

Add missing documentation or disable related CI job.
@krpeacock
Copy link
Contributor

I've put this off long enough. Issue accepted 😄

@krpeacock krpeacock mentioned this issue Jan 11, 2024
Merged
4 tasks
krpeacock added a commit that referenced this issue Jan 11, 2024
@krpeacock
chore: GitHub actions warning cleanup (#819)
eb3fa49 
* invalid JSDoc tag name "jest-environment"

* idl jsdoc warnings

* Missing JSDoc @param "s" description

* leb128 cleanup and strict arraybuffer type  enforcement

* npm audit

* changelog

fixes #811
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.

chore: GitHub actions warning cleanup dfinity/agent-js
2 participants
@krpeacock @peterpeterparker