You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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 againstably.d.ts
in CI.┆Issue is synchronized with this Jira Task by Unito
The text was updated successfully, but these errors were encountered: