RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 45/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Ruhig
- Tech-Stack
- ruby
- Bereich
- documentation
Rechercherichtung
Beginne damit nachzuverfolgen, wie RDoc die Dokumentation überschriebener Methoden behandelt und wie bestehende Direktiven dargestellt werden. Definiere das Verhalten der Direktive anhand des Beispiels Kernel.require und füge anschließend Tests hinzu, die zeigen, dass die ursprüngliche Dokumentation erhalten bleibt und die Dokumentation der überschreibenden Methode angehängt wird, statt sie zu ersetzen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
Use case: I wanted to find out how require worked.
Unfortunately, in RDoc-generated documentation, all I could find is information on how by requiring rubygems the behavior of Kernel.require changed, but nothing about its original behavior.
If RDoc had a directive to add, don't replace documentation, and it was used on the rubygems' monkeypatch of Kernel.require, the original documentation wouldn't have gotten lost.
- Vorherrschende Sprache
- Ruby
- Sterne
- 927
- Forks
- 467
- Ø Merge
- 1 T. 2 Std.
- Gemergte PRs (30 T.)
- 19
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus ruby/rdoc
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationEvtl. vergeben @OskarEichler hat das vor 40 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
ruby/rdoc#1759 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 68/100
ruby/rdoc#1823 · 5 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Wrong heading levels in generated HTML?Evtl. vergeben @st0012 hat das vor 5 Tagen übernommen. Offenbug
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
ruby/rdoc#1822 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
Local evaluation buckets percentage splits with the server key, so results differ from FlagsmithOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
-
Add PrestashopOffenrequest
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
endoflife-date/endoflife.date#11303 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 66/100
FreeTubeApp/FreeTube-Docs#245 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
Maintainer antworten meist innerhalb von 1 Tag