Skip to content

docstring formatting #956

@Roger-luo

Description

@Roger-luo

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    backlogdesign notes and backlogsdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions