Typos and confusing docs in the "Go Generated Code Guide (Open)"

Open Beginner friendly
#317 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
go
Domain
documentation

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.

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 int32 and one with a BirthYear *int32.
  • The docs reference FirstActiveYear but 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!

Dominant language
HTML
Stars
69
Forks
179
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from protocolbuffers/protocolbuffers.github.io

All issues in protocolbuffers/protocolbuffers.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.