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

Improve documentation on custom serializers #388

Closed
lyz-code opened this issue Apr 5, 2021 · 3 comments
Closed

Improve documentation on custom serializers #388

lyz-code opened this issue Apr 5, 2021 · 3 comments

Comments

@lyz-code
Copy link

lyz-code commented Apr 5, 2021

Even though the feature was merged in 2015, I found no reference of how to use them in the docs. I eventually arrived to tinydb-serialization where it's clear how to do it.

I think it would be useful to add some pointer in the docs to make it easier for developers

@lyz-code
Copy link
Author

lyz-code commented Apr 6, 2021

Sorry, I didn't saw #371 , maybe this can be a comment there

@msiemens
Copy link
Owner

msiemens commented Apr 9, 2021

I think it would be useful to add some pointer in the docs to make it easier for developers

If you found this in 2015, this was most likely part of the 2.x version of TinyDB. When I released TinyDB 3.0 which moved custom serializers to a separate package, there was a note about this in the release notes. But I'll add a note on the PR you mentioned in case someone else finds the reference to this feature when going through old pull requests 🙂

@msiemens
Copy link
Owner

msiemens commented Apr 9, 2021

I've added a note in the PR discussion. If you thinks this needs more documentat, feel free to comment and I'll reopen the issue

@msiemens msiemens closed this as completed Apr 9, 2021
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

No branches or pull requests

2 participants