Indexing needs improvement throughout

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

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
25/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞
领域
documentation

调研方向

No file or test is named. Start by locating the book's index source and existing uses of the tags, then review how concepts, code terms, capitalization, and acronyms are currently indexed. Done means the index follows all four stated rules throughout the book.

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

描述

Indices should:

  1. Serve as a reference for all important concepts and code terminology.
  2. All code such as while should be placed in the index as <idx><c>while</c></idx>. Of course, you cannot see anything that is between <idx> tags, so indexing is best done at the beginning of a sentence or paragraph.
  3. ONLY be capitalized if a proper noun or an acronym or code that must be capitalized. e.g. object-oriented programming should NOT be capitalized in the index
  4. Acronyms should appear in the index separately from what they stand for. e.g., OOP and object-oriented programming should be indexed separately.
主要语言
Python
星标
28
派生
42
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

RunestoneInteractive/java4python 的其他 Issue

查看 RunestoneInteractive/java4python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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