Skip to content
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.

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

Update documentation with example for custom serialization #977

Merged
merged 4 commits into from
Mar 11, 2024
Merged

Update documentation with example for custom serialization #977

merged 4 commits into from
Mar 11, 2024

Conversation

chrismostert
Copy link
Contributor

@chrismostert chrismostert commented Mar 11, 2024

📒 Description

Adds a small snippet to the documentation on how to register a custom serialization function for a specific data type. This approach can be used to resolve issues like #917
(Apologies for the messy PR #976, please consider this PR)

🔗 What I've Done

Since no changes in the code were required, the documentation has been updated with a small code snippet.

💬 Comments

Please check if the snippet is informative enough and in the correct place in the documentation

🛫 Checklist

Copy link

codecov bot commented Mar 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.97%. Comparing base (02c6b29) to head (6ac5fc8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #977      +/-   ##
==========================================
- Coverage   99.97%   99.97%   -0.01%     
==========================================
  Files         115      115              
  Lines        9040     9032       -8     
  Branches     2149     2148       -1     
==========================================
- Hits         9038     9030       -8     
  Misses          1        1              
  Partials        1        1              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tefra
Copy link
Owner

tefra commented Mar 11, 2024

I am wondering, if this example is too similar to this one, maybe we should expand that one, what do you think?

@chrismostert
Copy link
Contributor Author

chrismostert commented Mar 11, 2024

I am wondering, if this example is too similar to this one, maybe we should expand that one, what do you think?

I do agree that the general setup is quite similar! I feel like that example might be trying to explain too much if we also override some standard type's serialize function. I could move it as an additional snippet below that one with a heading of Overriding standard type conversion?

@tefra
Copy link
Owner

tefra commented Mar 11, 2024

I am wondering, if this example is too similar to this one, maybe we should expand that one, what do you think?

I do agree that the general setup is quite similar! I feel like that example might be trying to explain too much if we also override some standard type's serialize function. I could move it as an additional snippet below that one with a heading of Overriding standard type conversion?

Yes, let's do that thank you!

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Owner

@tefra tefra left a comment

Choose a reason for hiding this comment

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

Thank you @chrismostert

@tefra tefra merged commit 353855c into tefra:main Mar 11, 2024
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants