Skip to content

docs: note that the serde marker key is reserved - #993

Merged
skrawcz merged 1 commit into
apache:mainfrom
enekoreto:docs/serde-reserved-key
Oct 28, 2026
Merged

skrawcz merged 1 commit into
apache:mainfrom
enekoreto:docs/serde-reserved-key

Conversation

@enekoreto

Copy link
Copy Markdown
Contributor

Follow-up to the non-blocking docs suggestion in #934: say in the serde reference that the marker key is reserved.

Changes

  • docs/reference/serde.rst: burr.core.serde.KEY is reserved, and a dict of your own that contains it is still saved and loaded back as is, wrapped as burr.dict.
  • Same paragraph: don't use burr.dict as the key for your own deserializer, since register would replace Burr's handler (CanReader's note in the same PR).

How I tested this

  • On main, a dict containing the key (also nested, and inside State) round-trips through serialize/deserialize.
  • Registering a deserializer under burr.dict makes such a dict come back as whatever that function returns, so the warning is real.
  • The docs build with no warnings, same as main, and pre-commit passes.

Notes

This was done with AI assistance (Claude Code), and checked by running the cases above.

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@github-actions github-actions Bot added the area/website burr.apache.org website label Oct 22, 2026
@skrawcz
skrawcz enabled auto-merge (rebase) October 28, 2026 05:38
@skrawcz
skrawcz merged commit 0536598 into apache:main Oct 28, 2026
22 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/website burr.apache.org website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants