Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Move Gate Decomposition Figures to Markdown Documentation

Đang mở
#190 1 bình luận 0 reaction 1 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@vinayswamik đang làm issue này rồi.

Từ ngày 24/7/2025.

  • #237 của @vinayswamik — đã đóng, không merge

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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.
Ngôn ngữ chính
Python
Star
29
Fork
33
Merge trung bình
2 ngày 4 giờ
Pull request đã merge (30 ngày)
15

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của qBraid/pyqasm

Tất cả issue của qBraid/pyqasm

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.