How to put invisible comment in included file?
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- ruby
调研方向
从 ruby/ruby/doc/examples/files.rdoc 开始，检查 RDoc 如何处理包含的 .rdoc 文件中尝试使用 :stopdoc:/:startdoc:、=begin/=end 以及 HTML 样式注释形式的情况。确定是否可以使用现有语法隐藏警告，同时保留包含的示例，或者受支持的解决方案应具有什么行为；当生成的文档中不再出现警告且不影响示例时，即表示完成。
由索引模型根据 Issue 内容生成。
描述
Over at ruby/ruby/doc/examples/files.rdoc, we have some code that supports examples in IO, File, and now Pathname.
File files.rdoc is included elsewhere.
I'd like to put into it an invisible warning (comment) about changing the file, since others depend upon it so closely.
I've tried :stopdoc:/:startdoc: and =begin/=end. Even an HTML-style comment like .
Is there some way to make an invisible comment in an included .rdoc file.
- 主要语言
- Ruby
- 星标
- 930
- 派生
- 465
- 平均合并
- 3 天 4 小时
- 30 天内合并 PR
- 30
环境准备
从这里开始
- 先读完整个 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 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
solana-foundation/pay-kit#341 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
julienXX/terminal-notifier#333 ·
-
难度 1/5 1 小时以内 新手友好度 82/100
serhii-londar/open-source-mac-os-apps#1419 ·
维护者通常 5 天内回复