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

Add complete JSDoc annotations to ably.d.ts #848

Closed
owenpearson opened this issue Oct 28, 2021 · 1 comment · Fixed by #897
Closed

Add complete JSDoc annotations to ably.d.ts #848

owenpearson opened this issue Oct 28, 2021 · 1 comment · Fixed by #897
Assignees
@owenpearson

Comments

@owenpearson
Copy link
Member

owenpearson commented Oct 28, 2021 •
edited by sync-by-unito bot
Loading

The public API is currently pretty sparsely documented in terms of inline documentation. Most of the API is already well documented on ably.com/documentation so this will mainly just be a copy and paste job. Will allow developers to see documentation when hovering over symbols in most editors and will also allow us to generate a static API reference website.

eslint-plugin-jsdoc should be used to enforce standards and should be run against ably.d.ts in CI.

┆Issue is synchronized with this Jira Task by Unito
@owenpearson owenpearson mentioned this issue Feb 23, 2022
Merged
@owenpearson
Copy link
Member Author

Closed by #1028

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@owenpearson owenpearson

Labels
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add JSDoc annotations to ably.d.ts ably/ably-js
1 participant
@owenpearson