search

QuEraComputing / bloqade-python

QuEra's Neutral Atom SDK for Analog QPUs
https://bloqade.quera.com/
Other
57 stars 14 forks source link

docstring formatting #956

Open Roger-luo opened 6 months ago

Roger-luo commented 6 months ago

google style (see also sphinix google style) with markdown syntax in the context

short description of the function

Args:
   <name> (<type>): <explaination>

Returns:
   <type>: <explaination>

Raises:
   <exception>: <explaination>

Note:
   <description>

for functions in the builder chain, an extra hint on the following functions can be annotated after the above as https://github.com/QuEraComputing/bloqade-python/blob/142d349cefcc8fea93ad27d8d827b53a0b65b846/src/bloqade/builder/pragmas.py#L132