protocolbuffers / protocolbuffers/protocolbuffers.github.io
Typos and confusing docs in the "Go Generated Code Guide (Open)"
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- HTML
- Sterne
- 69
- Forks
- 179
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
There's a few typos and mis-documentations in the Go generated code guide:
- "Singular Explicit Presence Scalar Fields" and "Singular Implicit Presence Scalar Fields" have the same field definition, yet they claim to generate different structs, one with a
BirthYear int32and one with aBirthYear *int32. - The docs reference
FirstActiveYearbut no field of that name exists at HEAD. It was removed in https://github.com/protocolbuffers/protocolbuffers.github.io/pull/266. cc @Logofile - Message "Concer" is misspelled.
Thanks for taking a look!
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Dokumentation „Go Generated Code Guide (Open)“ zu finden und die Beispiele für explizite und implizite Presence im Singular zu vergleichen. Korrigiere die nicht übereinstimmenden Felddefinitionen und generierten Structs, entferne den veralteten Verweis auf FirstActiveYear und behebe den Tippfehler „Concer“; abgeschlossen ist die Aufgabe, wenn der Leitfaden dem aktuellen Verhalten des generierten Codes entspricht und keine der aufgeführten Fehler mehr enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- go
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Ruhig
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 78/100