Move Gate Decomposition Figures to Markdown Documentation
维护者通常 1 天内回复
评估
这个 Issue 还没有评估数据。
描述
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.
- 主要语言
- Python
- 星标
- 29
- 派生
- 33
- 平均合并
- 3 天 10 小时
- 30 天内合并 PR
- 17
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
qBraid/pyqasm 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 63/100
维护者通常 1 天内回复
-
enhancement error-handling program-validation
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
[BUG] dumps() emits extern calls without a semicolon, producing unparsable QASM可能已有人在做 @Jah-yee 于 31 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 25/100
维护者通常 1 天内回复
-
Parse failures raise ValidationError with an empty message; the ANTLR diagnostic is lost可能已有人在做 @tonycoder-hub 于 24 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 22/100
维护者通常 1 天内回复
-
`extern port` / `extern frame` in `cal` blocks fail to parse, blocking nearly every spec OpenPulse example可能重新可做 @Riiocodee 于 17 天前认领，目前没有进行中的 PR。 未关闭bug llm-assisted qasm3 qasm3-coverage
难度 4/5 3-5 天 新手友好度 35/100
维护者通常 1 天内回复
相似的 Issue
-
fuzz fuzz-unconfirmed
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
ready-for-agent
难度 2/5 1-3 小时 新手友好度 86/100
neilsh/stunt-reel#220 ·
维护者通常 1 天内回复
-
[Issue]: use_fp4_cache is accepted but ignored; the launcher always writes FP8 records可能已有人在做 @0z5a 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
area: cli priority: p3 size: S type: bug
难度 2/5 1-3 小时 新手友好度 83/100
finos/open-resource-broker#757 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 6 天内回复