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.

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

Improve Python API Documentation #58

Open
gwenchee opened this issue Jul 18, 2022 · 0 comments
Open

Improve Python API Documentation #58

gwenchee opened this issue Jul 18, 2022 · 0 comments

Comments

@gwenchee
Copy link
Collaborator

This issue can be closed when the following suggestion is implemented:

I'd recommend adding formatting to variable, function, and class names in the docstrings for your classes and functions so they render with styling and can be easily differentiated from normal text on the web-hosted API docs. This is a lot of work though so may be better suited for a new PR.

Originally posted by @yardasol in #53 (review)

@gwenchee gwenchee mentioned this issue Jul 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant