Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update serde.rst #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update serde.rst #555

wants to merge 2 commits into from

Conversation

@Mr-Ruben
Copy link

@Mr-Ruben Mr-Ruben commented Jun 20, 2025

As agreed here
#554
it would be helpful to mention some limitations/caveats.

I leave it to you how you want to express it.

Apologies if this is not the PR you were expecting. I don't know better.

Changes

How I tested this

Notes

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.

@Mr-Ruben
Update serde.rst
cc2cbde 
As agreed here
apache#554

it would be helpful to mention some limitations/caveats.
@Mr-Ruben Mr-Ruben mentioned this pull request Jun 20, 2025
Closed
@skrawcz
Copy link
Contributor

skrawcz commented Jun 21, 2025

@Mr-Ruben it doesn't appear that you added anything? It is the right file that was touched, but there's no actual content committed?

@Mr-Ruben
Copy link
Author

Mr-Ruben commented Jun 21, 2025

Additionally ...

I have noticed Burr has good 'early errors detection' like "you are doing ... but you haven't done ..."

You may consider adding 2 more:

  • If State has been / is being 'touched' by @serde.serialize.register(State) -> say something
  • If the class passed on .with_typing(PydanticTypingSystem(ApplicationState)) has been 'touched' by @serde.serialize.register(cls) -> say something

@skrawcz
Update serde.rst
6c17519 
adds limitation note
elijahbenizzy
elijahbenizzy approved these changes Jul 14, 2025
View reviewed changes
Copy link
Contributor

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

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

Looks good, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@elijahbenizzy elijahbenizzy elijahbenizzy approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Mr-Ruben @skrawcz @elijahbenizzy