Repository navigation
docs: document client_protocol_version in connection parameters table - #286
Open
reginaldalfret wants to merge 1 commit into
Open
reginaldalfret wants to merge 1 commit into
reginaldalfret wants to merge 1 commit into
Conversation
Adds client_protocol_version to the Connection Parameters table in README.rst and includes a usage example in the Client Transfer Protocol section. Fixes aws#276 Signed-off-by: reginaldalfret <reginaldalfret@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR documents the
client_protocol_versionconnection parameter in the Connection Parameters table inREADME.rst, and provides a code snippet in the Client Transfer Protocol section demonstrating how to passclient_protocol_version.Motivation and Context
Resolves #276
The
Client Transfer Protocolsection inREADME.rststates:However,
client_protocol_versionwas missing from the Connection Parameters table. This change adds the parameter name, type (int), description with supported values (0,1,2), default value (2), and required status (No).Testing
README.rst.git diff --check.pytest -c setup.cfg --ignore=test/performance --ignore=test/integration test/unit(2041 passed, 38 skipped).Types of changes
Checklist
pytest test/unitand they are passing.License