Quantinuum/qujax

Include function usage examples in docstrings/API documentation

Open

#112 opened on Nov 6, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (13 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (75 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Study existing docstrings in the qujax codebase, especially for functions like get params to statetensor func, and follow the pattern used in NumPy/SciPy documentation to add usage examples.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90