protocolbuffers / protocolbuffers/protocolbuffers.github.io
Typos and confusing docs in the "Go Generated Code Guide (Open)"
Nessuno ha ancora preso questa issue.
- Lingua principale
- HTML
- Stelle
- 69
- Fork
- 179
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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!
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando la documentazione “Go Generated Code Guide (Open)” e confronta gli esempi di presenza esplicita e implicita al singolare. Correggi le definizioni dei campi e le struct generate non corrispondenti, rimuovi il riferimento obsoleto a FirstActiveYear e correggi il refuso “Concer”; il lavoro è completato quando la guida corrisponde al comportamento attuale del codice generato e non contiene nessuno degli errori elencati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- go
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 78/100