protocolbuffers / protocolbuffers/protocolbuffers.github.io
Typos and confusing docs in the "Go Generated Code Guide (Open)"
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 69
- Forks
- 179
- PR merge metrics
- No merged PRs in 30d
Description
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!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the “Go Generated Code Guide (Open)” documentation and compare the singular explicit and implicit presence examples. Correct the mismatched field definitions and generated structs, remove the obsolete FirstActiveYear reference, and fix the “Concer” typo; done means the guide matches the current generated-code behavior and contains no listed errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100