The documentation for the bundled gem has not been updated

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞
技术栈
ruby
领域
documentation

调研方向

从 rake 注释任务以及它如何从 ruby/ruby 源代码树收集 RBS 文档开始。检查所列捆绑 gem 的表示方式,并决定应采用哪种文档方案来涵盖它们。完成的标准是:就一种方案达成一致,并更新捆绑 gem 的文档工作流。

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

描述

The rake annotation task generates documentation for RBS from the ruby/ruby source code. However, bundled gems are not included in the ruby/ruby source code. As a result, the rake annotate task that updates documentation does not update the documentation for bundled gems.

I think we need to decide on how to approach the documentation for bundled gems.

  • minitest
  • net-smtp
  • base64
  • bigdecimal
  • abbrev
  • nkf
  • csv
  • observer
主要语言
Ruby
星标
2.2k
派生
263
平均合并
1 天 20 小时
30 天内合并 PR
64

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

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

ruby/rbs 的其他 Issue

查看 ruby/rbs 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

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