ruby / ruby/delegate

SimpleDelegator documentation missing in ruby-docs.org

Offen
#5 3 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Ruby
Sterne
25
Forks
14
Ø Merge
8 Std. 41 Min.
Gemergte PRs (30 T.)
1

Beschreibung

Since 3.0.0, the library documentation is only partially rendered. Neither SimpleDelegator nor
the DelegateClass kernel method appear in the documentation.

https://ruby-doc.org/stdlib-3.0.0/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.1/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.2/libdoc/delegate/rdoc/Delegator.html

I'm not sure if splitting it into one file per top-level definition would solve it, but it might be the case that ruby-docs does not support several top-level definitions in the same file?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die verlinkten ruby-docs.org-Seiten für delegate 3.0.0 bis 3.0.2 zu vergleichen, und untersuche anschließend, wie die Top-Level-Definitionen der delegate-Bibliothek dargestellt werden. Die Arbeit ist abgeschlossen, wenn SimpleDelegator und die DelegateClass-Kernel-Methode in der generierten Dokumentation erscheinen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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