googleapis / googleapis/ruby-common-tools
cloudrad: Consider reworking method signature formatting to allow links
Geschlossen
priority: p3
type: feature request
- Vorherrschende Sprache
- Ruby
- Sterne
- 5
- Forks
- 13
- Ø Merge
- 1 Std. 2 Min.
- Gemergte PRs (30 T.)
- 10
Beschreibung
Reported by @NivedhaSenthil: ruby-doc.info formats method signatures not in code font, allowing types to be links. Consider doing the same.
Beitragsleitfaden
Rechercherichtung
Das Issue betrifft die Formatierung von Methodensignaturen in cloudrad und vergleicht sie mit ruby-doc.info. Beginne damit, den Einstiegspunkt des Formatters zu finden, und ermittle dann, wie Signaturen verlinkbare Typen offenlegen sollten; als erledigt gilt die Aufgabe, wenn generierte Signaturen diese Typ-Links ermöglichen, ohne die lesbare Formatierung zu verlieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- ruby
- Bereich
- documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100