Skip to content

DOCS-11940: uri option compressors and zlibcompressionlevel #3519

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

Merged
merged 1 commit into from
Dec 11, 2018
Merged

DOCS-11940: uri option compressors and zlibcompressionlevel #3519

merged 1 commit into from
Dec 11, 2018

Conversation

kay-kim
Copy link
Contributor

@kay-kim kay-kim commented Dec 11, 2018

@saghm - Could you review the addition of uri options compressors and zlibCompressionLevel to the uri page in the docs?

@@ -323,12 +323,74 @@ Connection Options
timeout, though different drivers might vary. See the
:ecosystem:`driver </drivers>` documentation.

* - .. urioption:: compressors
Copy link
Contributor Author

Choose a reason for hiding this comment

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

messages between the parties are uncompressed.


* - .. urioption:: zlibCompressionLevel
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link

@saghm saghm left a comment

Choose a reason for hiding this comment

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

All the phrasing seems good! I just have one minor suggestion to improve readability of the compressor list examples

If you specify multiple compressors, then the order in which you list
the compressors matter as well as the communication initiator. For
example, if the client specifies the following network
compressors ``zlib,snappy`` and the :binary:`~bin.mongod` specifies
Copy link

Choose a reason for hiding this comment

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

From looking at the rendered view, adding quotes to the compressors list examples (e.g. ``"zlib,snappy"``) might make them more readable in the browser, as it's a little tricky to notice that the comma before "messages" is not part of the compressors list. This is totally outside my expertise, though, so feel free to ignore this if you disagree!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! Will definitely add the quotes 👍

@kay-kim kay-kim merged commit c2f2b0c into mongodb:master Dec 11, 2018
@kay-kim kay-kim deleted the compressors-11940 branch September 15, 2019 01:05
mongo-cr-bot pushed a commit that referenced this pull request Jul 6, 2023
* DOCSP-31125 add curl to package import

* Force build
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