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

Include function usage examples in docstrings/API documentation #112

Open
gamatos opened this issue Nov 6, 2023 · 0 comments
Open

Include function usage examples in docstrings/API documentation #112

gamatos opened this issue Nov 6, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@gamatos
Copy link
Collaborator

gamatos commented Nov 6, 2023

It would be nice to have small usage examples for specific functions such as is done e.g. here or here. These examples would be included either directly in the docstring or in the corresponding documentation page.

For instance, get_params_to_statetensor_func could have examples of what happens when no parameterised gates are included in the circuit specification, how to supply custom operations (parameterised and non-parameterised), etc.

Most functions in qujax are currently in need of such examples.

@gamatos gamatos added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant