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

Double-check RPC function docstrings before beta release #4013

Open
mathemancer opened this issue Nov 5, 2024 · 0 comments
Open

Double-check RPC function docstrings before beta release #4013

mathemancer opened this issue Nov 5, 2024 · 0 comments
Labels
good first issue Everything in "Help wanted", PLUS being relatively easy and straightforward to implement. help wanted Community contributors can implement this needs: triage This issue has not yet been reviewed by a maintainer ready Ready for implementation type: maintenance Refactoring and technical debt payoff work: documentation Improvements or additions to documentation
Milestone
v0.2.0 (beta rele...

Comments

@mathemancer
Copy link
Contributor

Problem

We wrote a huge number of functions for the new RPC API, and it's likely that some of their docstrings aren't accurate. Since we generate API docs from docstrings, this leads to inaccurate API documentation.

Proposed solution

We should go through the RPC functions and double-check their docstrings.
@mathemancer mathemancer added work: documentation Improvements or additions to documentation good first issue Everything in "Help wanted", PLUS being relatively easy and straightforward to implement. help wanted Community contributors can implement this type: maintenance Refactoring and technical debt payoff ready Ready for implementation needs: triage This issue has not yet been reviewed by a maintainer labels Nov 5, 2024
@mathemancer mathemancer added this to the v0.2.0 (beta release) milestone Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Everything in "Help wanted", PLUS being relatively easy and straightforward to implement. help wanted Community contributors can implement this needs: triage This issue has not yet been reviewed by a maintainer ready Ready for implementation type: maintenance Refactoring and technical debt payoff work: documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.2.0 (beta release)
Development

No branches or pull requests
1 participant
@mathemancer