Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Move Gate Decomposition Figures to Markdown Documentation

Abierto
#190 1 comentario 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@vinayswamik ya está trabajando en esto.

Desde el 24/7/2025.

  • #237 de @vinayswamik — cerrado sin fusionar

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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.
Lenguaje dominante
Python
Estrellas
29
Forks
33
Merge medio
2 d 4 h
PR fusionados (30 d)
15

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de qBraid/pyqasm

Todos los issues de qBraid/pyqasm

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.