protocolbuffers / protocolbuffers/protocolbuffers.github.io
Typos and confusing docs in the "Go Generated Code Guide (Open)"
Abierto
Apto para principiantes
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- HTML
- Estrellas
- 69
- Forks
- 179
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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!
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza localizando la documentación “Go Generated Code Guide (Open)” y compara los ejemplos de presencia explícita e implícita en singular. Corrige las definiciones de campos y las estructuras generadas que no coinciden, elimina la referencia obsoleta a FirstActiveYear y corrige el error tipográfico “Concer”; la tarea estará terminada cuando la guía coincida con el comportamiento actual del código generado y no contenga ninguno de los errores indicados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- go
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Tranquilo
- Claridad
- Bien especificado
- Aptitud para principiantes
- 78/100