Aliki: Hard to discern method blocks visually
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
- design, documentation
Rechercherichtung
Beginne damit, die gemeldete Methodendokumentation und die rechte Seitenleiste in von RDoc generiertem HTML nachzubilden, wobei die Screenshots als visuelle Referenz dienen. Verfolge, wie Methodennamen, Args- und Description-Einträge gerendert werden, und identifiziere die relevanten Templates oder Styles. Als abgeschlossen gilt die Aufgabe, wenn Methodengrenzen visuell klar sind und die Einträge in der Seitenleiste angeben, zu welcher Methode sie gehören.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
I find it really hard to see where a method documentation starts and ends:
The headers "Args" and "Description" are much bigger than the method name although they are subordinate to it. This means when scrolling through the page it is hard - at least for me - to discern the part that belongs to a method.
I'm not sure whether this is the same problem but the right side bar is also quite useless in this case:
It is just a list of "Args" and "Description" entries without a hint for what.
- 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 65 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 11 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 24 Tagen übernommen. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 25/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 88/100
akitaonrails/ai-book-2026#12 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
openfoodfoundation/openfoodnetwork#14970 ·
Maintainer antworten meist innerhalb von 1 Tag
-
JWT::EncodedToken raises TypeError for a non-object headerEvtl. vergeben @anakinj hat das heute übernommen. Offenbug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
jwt/ruby-jwt#780 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 Unter einer Stunde Anfängerfreundlichkeit 70/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag