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

CONTRIBUTING.md should mention the process of adding/modifying the docstrings in the ably.d.ts (public types) #1929

Open
VeskeR opened this issue Nov 28, 2024 · 0 comments
Open

CONTRIBUTING.md should mention the process of adding/modifying the docstrings in the ably.d.ts (public types) #1929

VeskeR opened this issue Nov 28, 2024 · 0 comments
Labels
documentation Improvements or additions to public interface documentation (API reference or readme).

Comments

@VeskeR
Copy link
Contributor

VeskeR commented Nov 28, 2024 •
edited by sync-by-unito bot
Loading

The docstrings should come from the https://github.com/ably/sdk-api-reference repo (that repo should be the source of all docstrings that get added to our SDKs).
When updating existing docstrings should also open a PR in that repo with an update.
When adding new fields in the spec, should add docstrings to that repo.
See this comment in the PR.

┆Issue is synchronized with this Jira Task by Unito
@VeskeR VeskeR added the documentation Improvements or additions to public interface documentation (API reference or readme). label Nov 28, 2024
@VeskeR VeskeR mentioned this issue Nov 28, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to public interface documentation (API reference or readme).
Milestone
No milestone
Development

No branches or pull requests
1 participant
@VeskeR