Broken function documentation when using newer rubies and function contains any code before documentation
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
- 領域
- documentation, tooling
調査の方向性
lib/puppet/functions/to_yaml.rb と lib/puppet/functions/to_json.rb から始め、Puppet Strings 2.9.0 を使って Ruby 2.5 と 2.7 でリファレンス生成を再現します。require 文がドキュメントコメントに先行する場合に、ドキュメントコメントがどのように抽出されるかを追跡します; 完了条件は、報告された Ruby バージョン全体で両方の関数が一貫してドキュメントを生成することです。
索引モデルが issue の本文から書いたものです。
説明
I've noticed that when generating reference documentation for stdlib, the version of ruby used changes the output.
Specifically, the documentation for to_yaml and to_json doesn't get generated with Ruby 2.7 but does when using Ruby 2.5. (Puppet Strings 2.9.0 in both cases)
No other functions in stdlib are affected. There appears to be an issue with having any code before the documentation comments. In these functions, this is a require 'yaml' and require 'json' respectively. I could easily workaround the issue by moving this code into the function dispatches, but the change of behaviour between Ruby versions makes me think it's worth raising this as a bug here.
- 主要言語
- Ruby
- スター
- 90
- フォーク
- 91
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
puppetlabs/puppet-strings のほかの issue
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
puppetlabs/puppet-strings#389 · コメント 3 件 · リアクション 1 件 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
puppetlabs/puppet-strings#386 ·
-
maintenance
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
puppetlabs/puppet-strings#370 ·
-
bug
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
puppetlabs/puppet-strings#365 ·
-
community feature
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
puppetlabs/puppet-strings#353 ·
puppetlabs/puppet-strings の issue をすべて見る
似ている issue
-
🐞 bug pending triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
CircuitVerse/CircuitVerse#8031 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
riscv/riscv-unified-db#2740 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
GantMan/jail-monkey#380 ·