Skip to content

docs: small rustdoc, guide and error message fixes from #709 - #713

Merged
iainmcgin merged 10 commits into
anthropics:mainfrom
WeAreResilience:docs-709
Oct 14, 2026
Merged

iainmcgin merged 10 commits into
anthropics:mainfrom
WeAreResilience:docs-709

Conversation

@WeAreResilience

Copy link
Copy Markdown
Contributor

Fixes #709

Applies the checklist items from #709:

  • UnknownFields: rustdoc on the Extend and FromIterator impls.
  • docs/guide.md: by-reference conversions now mention the numeric and bool wrappers, and that StringValue/BytesValue convert by value only.
  • PoolError::NameTooLong: doc lists which names are checked (field and oneof names are not).
  • symbol_conflicts.rs: renamed field_and_oneof_names_do_not_gain_a_length_limit to field_and_oneof_names_longer_than_max_symbol_len_link.
  • PoolError::MessageSetWithFields: display text is now "MessageSet {message} declares a field; a MessageSet can have extensions only"; expected string in pool_e2e.rs updated; changelog fragment added.
  • protoc version for edition 2024 corrected to v32 in CONTRIBUTING.md:8, buffa-test/build.rs, README.md, docs/guide.md and buffa-build/README.md.
  • decode_from_str_with_element_memory_limit: first doc sentence says the budget is in bytes.

Not changed: CONTRIBUTING.md:88 and the conformance-local description in Taskfile.yml (protoc v30+ for the native conformance run), since the issue leaves those conditional on the reason being edition 2024.

Testing (toolchain 1.95.0):

  • cargo test -p buffa-descriptor --all-features: all pass; messageset_declared_fields_are_rejected_transactionally fails with the old message and passes with the new one.
  • cargo test -p buffa --all-features --lib unknown_fields: pass.
  • cargo fmt --all -- --check, cargo clippy -p buffa -p buffa-descriptor --all-features --all-targets, RUSTDOCFLAGS="-D warnings" cargo doc -p buffa -p buffa-descriptor --all-features --no-deps: clean.

@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@WeAreResilience

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Oct 13, 2026
…sion

PoolError::MessageSetWithFields is not in a release, so a Changed entry
for its text would describe a change no user sees. The editions_2024
test module names protoc v32+ like the build script. The guide sentence
about the chrono and jiff conversions sits with the Timestamp and
Duration sentence it refers to, and five long lines are wrapped.

@iainmcgin iainmcgin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[claude code] Pushed one commit (fe87875):

  • Removed the Changed fragment. PoolError::MessageSetWithFields was added by #599 and is not in a release yet, so the release notes would describe a change to a text that users have not seen.
  • buffa-test/src/tests/editions_2024.rs also said "protoc v30+"; it now says v32+. The issue did not list it.
  • In the guide, the chrono and jiff sentence moved up beside the Timestamp and Duration sentence it refers to. With the wrapper sentences in between, "This" read as the wrappers. That placement came from the issue text.
  • Five added lines are wrapped to the width of the lines around them.

@WeAreResilience

Copy link
Copy Markdown
Contributor Author

Thanks — those fixes look right, especially dropping the unreleased Changed entry and moving the chrono/jiff sentence so This points at Timestamp/Duration again.

@iainmcgin
iainmcgin added this pull request to the merge queue Oct 14, 2026
Merged via the queue into anthropics:main with commit bd52818 Oct 14, 2026
11 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: small fixes to rustdoc, the guide and one error message after #597, #599, #604 and #612

2 participants