How to put invisible comment in included file?
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR（30日）
- 30
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 1週間以上 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
security
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
Mend: dependency security vulnerability
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
Mend: dependency security vulnerability
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信
-
homebrew warningsオープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
bradygaster/squad#2082 ·
メンテナーはふだん 1 日以内に返信