Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Move Gate Decomposition Figures to Markdown Documentation

Aperta
#190 1 commento 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@vinayswamik ci sta già lavorando.

Dal 24/7/2025.

  • #237 di @vinayswamik — chiusa senza merge

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

documentation good first issue no-qc-knowledge-reqd

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.
Lingua principale
Python
Stelle
29
Fork
33
Merge medio
2g 4h
PR unite (30g)
15

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di qBraid/pyqasm

Tutte le issue di qBraid/pyqasm

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.