lobster_rst_report escapes list-table rows inside requirement text and produces invalid RST
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 68/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- rust
- 领域
- documentation, tooling
调研方向
从 tools/lobster_rst_report 开始，追踪嵌入 traceability_report/feature_requirements.rst 中的需求文本的渲染或转义路径。使用包含嵌套 .. list-table:: 的需求进行复现，然后验证生成的表格保留未转义的行标记，并被 Sphinx/docutils 接受。
由索引模型根据 Issue 内容生成。
描述
Summary
When a requirement description contains a valid nested .. list-table::, the generated multi-page Lobster RST report escapes the table row markers (* - becomes \* -), and Sphinx/docutils then rejects the generated page.
Observed behavior
Generated file:
traceability_report/feature_requirements.rst
Error:
Error parsing content block for the "list-table" directive: exactly one bullet list expected.
In the generated report, the table body is rendered with escaped row markers like:
.. list-table::
:header-rows: 1
\* - #
- Mode 0
- Mode 1
instead of valid rows:
.. list-table::
:header-rows: 1
* - #
- Mode 0
- Mode 1
Expected behavior
Nested RST table content inside requirement text should remain valid in the generated traceability report.
Why this looks like a tooling bug
- The original requirement page renders the table correctly.
- The failure appears only in the generated Lobster RST report.
- The generated report escapes markup that must remain structural RST.
Impact
Valid migrated requirement content cannot be reused safely in Lobster-generated report pages if it contains structured RST tables.
Reproduction hint
A feature requirement with a description containing:
- prose
- a nested
.. list-table:: - normal
feature_requirementsgeneration - dependable element / Lobster traceability report generation
Suspected area
tools/lobster_rst_report rendering / escaping logic for requirement text embedded into report pages.
- 主要语言
- Rust
- 星标
- 8
- 派生
- 38
- 平均合并
- 1 天 10 小时
- 30 天内合并 PR
- 41
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
eclipse-score/tooling 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
eclipse-score/tooling#499 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 48/100
eclipse-score/tooling#458 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 48/100
eclipse-score/tooling#452 · 1 条评论 ·
维护者通常 1 天内回复
-
coverage: integration mode — scope external module roots (reference_integration)可能重新可做 @dcalavrezo-qorix 于 59 天前认领，目前没有进行中的 PR。 未关闭
eclipse-score/tooling#445 · 1 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Migration path rst to trlc可能重新可做 @antonkri 于 61 天前认领，目前没有进行中的 PR。 未关闭
eclipse-score/tooling#441 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 eclipse-score/tooling 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 85/100
farion1231/cc-switch#8829 ·
维护者通常 1 天内回复
-
bug ci good first issue
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 92/100
longbridge/gpui-kit#3677 ·
维护者通常 1 天内回复
-
E-pr-welcome
难度 2/5 1-3 小时 新手友好度 77/100
seanmonstar/reqwest#3121 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 68/100
ilya-zlobintsev/LACT#1235 ·
维护者通常 1 天内回复