rdoc 6.13.1 does not detect `private :new`
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 55/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- ruby
调研方向
从 foo.rb 复现程序开始，运行 rdoc 来检查 private :new 在生成的文档中是如何表示的。跟踪 parser 对 private 声明的处理，并验证生成的文档不再列出类方法 new，而 initialize 仍未被记录到文档中。
由索引模型根据 Issue 内容生成。
描述
I'm not sure if this is a bug report or a feature request; I think it has worked in the past but I'm not sure.
Given an input foo.rb:
# Example Foo class should not document private new
class Foo
class << self
private :new
end
# This should not be documented
def initialize(...)
end
end
The generated documentation should not document the new class method.
I can work around this by adding # :nodoc:, but it feels like something that should be detected by the parser.
I'm updating a gem to be Ruby 3.2+, so if there's a better way to mark a private new in those versions that rdoc does detect, I can use that instead.
- 主要语言
- Ruby
- 星标
- 930
- 派生
- 465
- 平均合并
- 2 天 16 小时
- 30 天内合并 PR
- 28
环境准备
从这里开始
- 先读完整个 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未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 68/100
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 1 天内回复
-
难度 5/5 一周以上 新手友好度 35/100
维护者通常 1 天内回复
相似的 Issue
-
security
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
OSCON 2016未关闭content
难度 2/5 1-3 小时 新手友好度 68/100
rubyevents/rubyevents#2148 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
we-promise/sure#3838 · 2 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 88/100
simp/pupmod-simp-pam#244 ·
维护者通常 7 天内回复
-
Mend: dependency security vulnerability
难度 2/5 1-3 小时 新手友好度 68/100
ManageIQ/manageiq-ui-classic#10341 ·
维护者通常 1 天内回复