More documentation for methods in RDoc
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 25/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- ruby
- Bereich
- documentation, tooling
Rechercherichtung
Beginne mit lib/rdoc/parser.rb ungefähr bei Zeile 254 und sieh dir die Methodenparameter und den bestehenden Stil der RDoc-Kommentare an. Der Umfang des Issues muss eingegrenzt werden; die Fertigstellung würde bedeuten, konsistente Kommentare im RDoc-Format für eine vereinbarte Menge von Methoden hinzuzufügen, wobei jegliche Typannotationen als separate Entscheidung behandelt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Problem
When I look into a source code of RDoc to debug, it's so hard to read it due to the lack of proper documentation.
For example, https://github.com/ruby/rdoc/blob/master/lib/rdoc/parser.rb#L254 has 5 parameters and I don't know what content is at all. And options is usually a Hash in other gems, but here RDoc::Options instance is expected.
While we can guess some of them, it's not ideal.
Suggestion
My proposal is to add more comments to existing source code of RDoc. This will help us read it better, understand it better and improve it better.
I'd appreciate it if current maintainers do this since they understand the structure of the code well, I could do this as well.
Misc
The documentation format will be RDoc format.
Other ideas
Or, it might be worth adding types to RDoc.
- Vorherrschende Sprache
- Ruby
- Sterne
- 928
- Forks
- 471
- Ø Merge
- 2 T. 4 Min.
- Gemergte PRs (30 T.)
- 13
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
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationEvtl. vergeben @OskarEichler hat das vor 66 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
-
markdown html excerpt includes link partsEvtl. vergeben @anyingiit hat das vor 12 Tagen übernommen. Offen
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 66/100
Maintainer antworten meist innerhalb von 1 Tag
-
Regexp generated from unescaped input in #expand_classEvtl. vergeben @jaynetics hat das vor 25 Tagen übernommen. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 25/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Maintainer antworten meist innerhalb von 1 Tag
-
👩💻 équipe CE fonctionnalité
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 63/100
betagouv/conseillers-entreprises#4779 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Poetry updater rejects OR (||) Python constraints in PyprojectPreparer#update_python_requirementOffenL: python L: ruby:bundler
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
dependabot/dependabot-core#16819 ·
Maintainer antworten meist innerhalb von 1 Tag
-
resource: surah-info
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
TarteelAI/quranic-universal-library#996 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Missing ar translation: components/common/CommunitySolution.tsx:communitySolution.authorsSolutionOffen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100
Maintainer antworten meist innerhalb von 1 Tag