Support for Java classes in JRuby
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 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
- 星标
- 927
- 派生
- 467
- 平均合并
- 23 小时 47 分钟
- 30 天内合并 PR
- 12
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 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可能已有人在做 @OskarEichler 于 44 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
Regexp generated from unescaped input in #expand_class可能已有人在做 @jaynetics 于 3 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 25/100
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 68/100
维护者通常 1 天内回复
-
Wrong heading levels in generated HTML?可能已有人在做 @st0012 于 9 天前认领。 未关闭bug
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 66/100
demarche-numerique/demarche.numerique.gouv.fr#14301 ·
维护者通常 1 天内回复
-
needs verification
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 6 天内回复
-
L: java:gradle L: java:maven L: ruby:bundler T: bug 🐞
难度 2/5 1-3 小时 新手友好度 76/100
dependabot/dependabot-core#16547 ·
维护者通常 1 天内回复
-
Properties named open and close collide with query delimiter tokens可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 8 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复