C++ API docs out of date?
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- cpp
- Domain
- documentation
Research direction
Compare the migration guide with the C++ API documentation for the Descriptor page and the referenced descriptor.h line 362. Verify which documented return types differ from the v30 absl::string_view signatures, update the affected API documentation, and confirm the pages consistently mirror the header.
Written by the indexing model from the issue text.
Description
The C++ API documentation does not appear to mirror the new absl::string_view return types introduced in v30.
https://protobuf.dev/support/migration/#string_view-return-type - describes the change in return types
https://protobuf.dev/reference/cpp/api-docs/google.protobuf.descriptor/#Descriptor - indicates returning const std::string&
https://github.com/protocolbuffers/protobuf/blob/01331f9e51775b7e11f8b61d778ea98ddb522ad1/src/google/protobuf/descriptor.h#L362 - returns absl::string_view
- Dominant language
- HTML
- Stars
- 69
- Forks
- 179
- PR merge metrics
- No merged PRs in 30d
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.
More from protocolbuffers/protocolbuffers.github.io
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Protocol Buffers Open
Difficulty 5/5 Over a week Newbie friendliness 15/100
protocolbuffers/protocolbuffers.github.io#319 · 1 comment ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
All issues in protocolbuffers/protocolbuffers.github.io
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
certification
Difficulty 1/5 Under an hour Newbie friendliness 80/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
bisq-network/support#2181 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
tutorial updates Open
Difficulty 1/5 Under an hour Newbie friendliness 80/100
sveltejs/svelte.dev#2241 ·