Suggest swclient and version in README, pydocs#6
Merged
Conversation
This commit adds swclient and version parameters to example usage of Client to encourage users to make use of those parameters so that clients are more easily identifiable in log data.
|
lgtm |
djw1149
suggested changes
Feb 9, 2022
djw1149
left a comment
Contributor
There was a problem hiding this comment.
I suggest you include the limits of swclient and version from the API docs:
swclient | Limited to twenty alphanumeric characters.
version | Limited to twenty alphanumeric characters plus dash, underscore, and period.
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
3 participants
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.
This commit adds swclient and version parameters to example usage of
Client to encourage users to make use of those parameters so that
clients are more easily identifiable in log data.