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

Add documentation for new compression schemes #5384

Merged
merged 3 commits into from
Mar 13, 2019

Conversation

huangsam
Copy link
Contributor

Note: Before submitting this pull request, please review our contributing
guidelines
.

Description

Attempting to fill in the missing gaps for Celery user guides regarding newly supported compression schemes. I added spacing between the compression schemes so as to allow more room for scheme sub-sections if necessary. This should resolve #5328.

@huangsam
Copy link
Contributor Author

Screen Shot 2019-03-12 at 10 16 50 PM

This is how the documentation looks with the changes.

@huangsam
Copy link
Contributor Author

Interestingly enough, running make html on the Sphinx docs with Python 3.7.2 fails while running make html with Python 3.6.6 works fine with a couple of warnings. Not sure if that's because of the particular Sphinx version that Celery is using under the hood.

Copy link
Member

@auvipy auvipy left a comment

Choose a reason for hiding this comment

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

good start

@codecov
Copy link

codecov bot commented Mar 13, 2019

Codecov Report

Merging #5384 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5384   +/-   ##
=======================================
  Coverage   83.39%   83.39%           
=======================================
  Files         144      144           
  Lines       16466    16466           
  Branches     2050     2050           
=======================================
  Hits        13731    13731           
  Misses       2526     2526           
  Partials      209      209

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 93afcb4...3de8e93. Read the comment docs.

@codecov
Copy link

codecov bot commented Mar 13, 2019

Codecov Report

Merging #5384 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5384   +/-   ##
=======================================
  Coverage   83.39%   83.39%           
=======================================
  Files         144      144           
  Lines       16466    16466           
  Branches     2050     2050           
=======================================
  Hits        13731    13731           
  Misses       2526     2526           
  Partials      209      209

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 93afcb4...ac57fe0. Read the comment docs.

@huangsam
Copy link
Contributor Author

Screen Shot 2019-03-12 at 11 26 37 PM

The PR has been modified to include descriptions for each compression scheme - to help the user in making an informed choice on what is best for their particular use case(s).

@thedrow
Copy link
Member

thedrow commented Mar 13, 2019

Looks good. The only thing that's missing is to say that Kombu has an extra dependency for most of those.
So pip install kombu[brotli] will install the appropriate brotli implementation.

@thedrow
Copy link
Member

thedrow commented Mar 13, 2019

Done. Let's ensure that the build passes and merge this.

@thedrow thedrow merged commit 95fd16f into celery:master Mar 13, 2019
@huangsam huangsam deleted the docs_compression_schemes branch March 13, 2019 15:12
jeyrce pushed a commit to jeyrce/celery that referenced this pull request Aug 25, 2021
* Add documentation for new compression schemes

* Add descriptions to each compression scheme

* Add installation instructions.
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 our documentation for the new compression methods introduced in Kombu 4.3
3 participants