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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update serializer docs #7858

Merged
merged 2 commits into from
Oct 30, 2022
Merged

Update serializer docs #7858

merged 2 commits into from
Oct 30, 2022

Conversation

sondrelg
Copy link
Contributor

@sondrelg sondrelg commented Oct 28, 2022

Fixes #7855

The PR addresses two points:

  • The current serializer docs don't tell users how to install serializer libraries. Celery has added extras for these, so I added instructions below the relevant serializer options. Pickle and JSON don't need them. Followed the same format as the compressions docs just below.
  • The new docs link to the accept_format docs which are pretty good, and adds a line to warn about what happens if this isn't specified correctly.

And I removed the "young format" warning from the msgpack description 馃檪

The msgpack disclaimer no longer applies,
and the docs now link to the accept_content
setting
@@ -454,7 +454,7 @@ Each option has its advantages and disadvantages.

json -- JSON is supported in many programming languages, is now
a standard part of Python (since 2.6), and is fairly fast to decode
using the modern Python libraries, such as :pypi:`simplejson`.
Copy link
Member

Choose a reason for hiding this comment

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

and is fairly fast to decode
using the modern Python libraries, such as :pypi:simplejson.
using modern Python libraries, such as :pypi:simplejson.

this part can be completely removed or rephrased as celery do not use simplejson anymore

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in 7219ca3 馃憤

@auvipy auvipy merged commit 0034a7b into celery:master Oct 30, 2022
@auvipy auvipy added this to the 5.3 milestone Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update serialization docs
2 participants