Adding YARD document support to RDoc
维护者通常 1 天内回复
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- ruby
调研方向
首先查看 pull request #1321 和链接的讨论，以了解为什么推迟了插件方案。使用第一个未勾选的路线图条目来确定一个范围明确的贡献；完成内容应覆盖一项已达成共识的 YARD 能力，例如基本框架或列出的标签，而不是整个功能集。
由索引模型根据 Issue 内容生成。
描述
Background
I implemented a plugin system for RDoc in https://github.com/ruby/rdoc/pull/1321 and YARD parsing plugin is implemented.
In the discussion with @st0012, @kou and @vinistock we decided that we should implement YARD parsing feature as a standalone feature without plugin.
The note exists in https://github.com/ruby/rdoc/discussions/1257#discussioncomment-12882912
Steps
There are some steps to have effective YARD parsing feature in RDoc.
- Adding basic framework to support YARD style document (
RDoc::Yardclass or similar) - Adding support of YARD tags that already works with current RDoc such as
@yieldand@private-
@yield -
@private
-
- Adding support of YARD tags that needs simple modification of RDoc such
@deprecated- Adding
:deprecateddirective - Adding
@deprecated
- Adding
- Adding features such as type support to utilize information from YARD
-
@return -
@param - others (will be edited later)
-
- Adding support of YARD directives and macros
-
@!attribute - others (will be edited later)
-
I will implement these step by step.
Note
The idea of plugin system is not completely abandoned but postponed.
- 主要语言
- Ruby
- 星标
- 927
- 派生
- 467
- 平均合并
- 23 小时 47 分钟
- 30 天内合并 PR
- 12
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
ruby/rdoc 的其他 Issue
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation可能已有人在做 @OskarEichler 于 44 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
Regexp generated from unescaped input in #expand_class可能已有人在做 @jaynetics 于 2 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 25/100
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 68/100
维护者通常 1 天内回复
-
Wrong heading levels in generated HTML?可能已有人在做 @st0012 于 9 天前认领。 未关闭bug
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 8 天内回复
-
bug: "Conversation information" accordion renders blank with 0px height when conversation has no attributes可能已有人在做 @gihovani 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 2 天内回复
-
`hanami generate repository` would be a nice alias for `hanami generate repo`可能已有人在做 @sandbergja 今天认领。 未关闭bug help wanted
难度 2/5 1-3 小时 新手友好度 74/100
hanami/hanami-cli#455 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 69/100
asciidoctor/asciidoctor#4882 · 4 条评论 ·