Repository navigation
docs: note that the serde marker key is reserved - #993
Merged
Merged
Conversation
skrawcz
approved these changes
Oct 28, 2026
skrawcz
enabled auto-merge (rebase)
October 28, 2026 05:38
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.KEYis reserved, and a dict of your own that contains it is still saved and loaded back as is, wrapped asburr.dict.burr.dictas the key for your own deserializer, sinceregisterwould replace Burr's handler (CanReader's note in the same PR).How I tested this
State) round-trips throughserialize/deserialize.burr.dictmakes such a dict come back as whatever that function returns, so the warning is real.Notes
This was done with AI assistance (Claude Code), and checked by running the cases above.
Checklist