Support for Java classes in JRuby
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 32/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
まず、リンクされたパッチと、RDoc における既存の ri 処理を確認します。--java/-j オプションと JRuby ランタイムのリフレクションを、プラグインなしでどのように統合できるかを判断します。JRuby が ri を通じて Java クラスのメソッドと引数の型を表示でき、新しい動作がテストでカバーされれば完了です。
索引モデルが issue の本文から書いたものです。
説明
I was recently reminded of a patch I threw together 15 years ago to support documenting Java classes with ri in JRuby. Today I found that patch:
https://gist.github.com/headius/276803
This is a very loose concept based on rdoc from 2010, but the logic should still work today. When the --java or -j flag is passed, instead of using the usual stores for docs, we use runtime reflection to load the class and method(s) in question. The compiled code available at runtime does not have text documentation, but we can still display the method names and argument types, which would be a big help for JRuby users.
As this is very specific to JRuby, I wanted to ask how we might get an updated version of this patch integrated. I could not see a good way to do a JRuby-specific plugin, but I have not dug very deep.
It could also simply be added as a feature that is only available when running on JRuby.
An example of the output:
~/projects/jruby ➔ ri -j java.lang.Object
------------------------------------------------ Class: java.lang.Object
(no description...)
------------------------------------------------------------------------
Instance methods:
-----------------
equals, getClass, hashCode, notify, notifyAll, toString, wait
~~/projects/jruby ➔ ri -j java.lang.String.split
------------------------------------------------- java.lang.String#split
split(java.lang.String,int) => java.lang.String[]
split(java.lang.String) => java.lang.String[]
------------------------------------------------------------------------
(no description...)
- 主要言語
- Ruby
- スター
- 928
- フォーク
- 469
- 平均マージ
- 23時間 47分
- マージ済み PR（30日）
- 12
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ruby/rdoc のほかの issue
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentation対応中かも @OskarEichler が 47 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
Regexp generated from unescaped input in #expand_class対応中かも @jaynetics が 5 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
Wrong heading levels in generated HTML?対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
bugsnag
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
JoeMcB/improvcoaches#827 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
TheOdinProject/curriculum#31465 ·
メンテナーはふだん 1 日以内に返信
-
area: docs eco: ruby good first issue help wanted lane: free-agent roadmap size: XS type: docs
難易度 1/5 1時間未満 初心者へのやさしさ 66/100
arminazimi/evergreen#465 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
simp/puppetsync#120 ·
メンテナーはふだん 2 日以内に返信