Consider displaying accessors (`Attributes`) in sidebar or merging with Instance Methods

未关闭
#1,579 2 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
ruby
领域
documentation

调研方向

首先生成 Net::HTTP 的 RDoc 输出,并检查侧边栏如何区分访问器和实例方法。将侧边栏与主方法列表进行比较,然后确认 ca_cert、cert 和 key 等访问器方法可以在侧边栏中找到,或者已合并到实例方法部分中。

由索引模型根据 Issue 内容生成。

描述

Certain classes contain a collection of useful instance methods that become less visible due to their status as accessors, leading to their omission from the sidebar.

For instance, Net::HTTP includes various configuration options for the SSL context, such as ca_cert, cert, and key. However, these options are located towards the bottom of the main viewport, making them less easily discoverable.

Listing them in the sidebar would enhance their visibility and accessibility.

主要语言
Ruby
星标
928
派生
471
平均合并
2 天 4 分钟
30 天内合并 PR
13

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ruby/rdoc 的其他 Issue

查看 ruby/rdoc 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。