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

Properly document python public APIs #1000

Open
reyammer opened this issue Mar 17, 2025 · 0 comments
Open

Properly document python public APIs #1000

reyammer opened this issue Mar 17, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation python Pull requests that update Python package

Comments

@reyammer
Copy link
Collaborator

reyammer commented Mar 17, 2025 •
edited
Loading

The API is somehow documented in python/README.md, but we should improve it, with docstrings or whatever the best practice is (e.g., the docs should appear in vscode when using it as a library, etc.)
@reyammer reyammer mentioned this issue Mar 17, 2025
Closed
10 tasks
@reyammer reyammer added documentation Improvements or additions to documentation python Pull requests that update Python package labels Mar 17, 2025
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 documentation python Pull requests that update Python package
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@reyammer