-
Notifications
You must be signed in to change notification settings - Fork 8
Add module level docstrings #727
Copy link
Copy link
Open
Labels
E-lowarea: docsArea: documentation, tutorials, and examples.Area: documentation, tutorials, and examples.category: documentationCategory: improvements, additions, or needs for documentation.Category: improvements, additions, or needs for documentation.category: enhancementCategory: this is an enhancement of an existing feature.Category: this is an enhancement of an existing feature.priority: mediumPriority: medium priority issues and tasks, default priority.Priority: medium priority issues and tasks, default priority.
Metadata
Metadata
Assignees
Labels
E-lowarea: docsArea: documentation, tutorials, and examples.Area: documentation, tutorials, and examples.category: documentationCategory: improvements, additions, or needs for documentation.Category: improvements, additions, or needs for documentation.category: enhancementCategory: this is an enhancement of an existing feature.Category: this is an enhancement of an existing feature.priority: mediumPriority: medium priority issues and tasks, default priority.Priority: medium priority issues and tasks, default priority.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Right now, we have no module level docstrings in the respective
__init__.pyfiles. This leads to the API reference, which is autogenerated, to show an empty page on submodules. For example, here https://bloqade.quera.com/latest/reference/bloqade-circuit/src/bloqade/analysis/We should add these throughout simply for the benefit of having a nicer API reference. Each description should inlcude