Scribble page info returns incorrect source file

未关闭
#471 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
25/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

首先跟踪 drracket/scribblings/drracket/drracket.scrbl 中 Keyboard Shortcuts 部分的页面信息行为。通过 interface-ref.scrbl 跟随其 @include-section 到 keybindings.scrbl,并将报告的源文件与预期文件进行比较。在确定修复应涵盖的范围之前,审查从 manuals 或 scribble/manual 中移除 @include-section 的替代方案。

由索引模型根据 Issue 内容生成。

描述

What program did you run?
https://docs.racket-lang.org/drracket/Keyboard_Shortcuts.html

3.3 Keyboard Shortcuts

Link to this section with
@secref["Keyboard Shortcuts"
#:doc '(lib "scribblings/drracket/drracket.scrbl")]
Document source
https://github.com/racket/drracket/tree/master/drracket/scribblings/drracket/drracket.scrbl

Image

What should have happened?
Follow @include-section from
https://github.com/racket/drracket/blob/master/drracket/scribblings/drracket/drracket.scrbl
via https://github.com/racket/drracket/blob/master/drracket/scribblings/drracket/interface-ref.scrbl
to return https://github.com/racket/drracket/blob/master/drracket/scribblings/drracket/keybindings.scrbl

**alternative **

eliminate @include-section from manuals,
consider removing @include-section from scribble/manual

主要语言
Racket
星标
251
派生
101
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

racket/scribble 的其他 Issue

查看 racket/scribble 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。