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

Offen
#1,579 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
ruby
Bereich
documentation

Rechercherichtung

Beginne damit, die RDoc-Ausgabe für Net::HTTP zu erzeugen, und prüfe, wie die Seitenleiste Accessors von Instanzmethoden unterscheidet. Vergleiche die Seitenleiste mit der Hauptliste der Methoden und verifiziere anschließend, dass Accessor-Methoden wie ca_cert, cert und key in der Seitenleiste auffindbar sind oder in den Abschnitt für Instanzmethoden integriert wurden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Ruby
Sterne
928
Forks
470
Ø Merge
2 T. 4 Min.
Gemergte PRs (30 T.)
13

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus ruby/rdoc

Alle Issues in ruby/rdoc

Ähnliche Issues

Weitere Issues zu Ruby

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.