-
Notifications
You must be signed in to change notification settings - Fork 19
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersno-qc-knowledge-reqdDoes not require knowledge of QC or QISDoes not require knowledge of QC or QIS
Description
Description
Refactor the gates.py file by relocating all gate decomposition figures (currently included as ASCII diagrams or docstring illustrations) into a dedicated Markdown documentation file (e.g., docs/gate_decompositions.md). The gates.py file will then reference the Markdown file, rather than embedding decomposition figures directly in code or docstrings.
Implementation
- Extraction: Identify and extract all gate decomposition figures, ASCII diagrams, and explanatory illustrations from
gates.py. - Documentation: Create a new Markdown file (e.g.,
docs/gate_decompositions.md) and organize the decompositions by gate name/type, preserving all relevant explanations and diagrams. - Reference Update: In
gates.py, replace each removed figure with a reference or link to the corresponding section in the Markdown file. For example:
# See docs/gate_decompositions.md#crx-gate for decomposition details.- README Update: Optionally, add a reference to the new documentation file in the project README and relevant configs.
- Testing: Ensure that docstring removals do not affect code execution or automated documentation builds.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomersno-qc-knowledge-reqdDoes not require knowledge of QC or QISDoes not require knowledge of QC or QIS