Aliki: Hard to discern method blocks visually
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- ruby
- 领域
- design, documentation
调研方向
首先使用截图作为视觉参考，在 RDoc 生成的 HTML 中复现所报告的方法文档和右侧边栏。跟踪方法名称以及 Args 和 Description 条目的渲染方式，并确定相关的模板或样式。当方法边界在视觉上清晰，并且侧边栏条目标明其所属的方法时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
I find it really hard to see where a method documentation starts and ends:
The headers "Args" and "Description" are much bigger than the method name although they are subordinate to it. This means when scrolling through the page it is hard - at least for me - to discern the part that belongs to a method.
I'm not sure whether this is the same problem but the right side bar is also quite useless in this case:
It is just a list of "Args" and "Description" entries without a hint for what.
- 主要语言
- 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 于 43 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
Regexp generated from unescaped input in #expand_class可能已有人在做 @jaynetics 于 2 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 25/100
维护者通常 1 天内回复
-
enhancement
难度 4/5 3-5 天 新手友好度 68/100
维护者通常 1 天内回复
-
Wrong heading levels in generated HTML?可能已有人在做 @st0012 于 8 天前认领。 未关闭bug
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 1 天内回复
相似的 Issue
-
documentation
难度 1/5 1 小时以内 新手友好度 86/100
bridgetownrb/bridgetown#1130 ·
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
stripe/stripe-ruby#1994 ·
维护者通常 1 天内回复
-
[Fehler]: /abdeckstift wirft 500 — part_type aus der Phonemreduction-Umbenennung nicht mitgezogen未关闭bug
难度 2/5 1-3 小时 新手友好度 73/100
wort-schule/wort.schule#787 ·
-
bug
难度 2/5 1-3 小时 新手友好度 76/100
lugassawan/swe-workbench#799 ·
维护者通常 1 天内回复
-
2.8.6: NoMethodError "undefined method 'first'" in profdata_coverage_dir whenever --scheme is used未关闭
难度 2/5 1-3 小时 新手友好度 70/100
SlatherOrg/slather#586 · 2 条评论 ·