fix docstring typo; set default #28
Merged
Conversation
This file contains 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
| @@ -96,7 +96,7 @@ def __init__(self, host, | |||
| :param num_retries: (Optional) Number of retries for connection attempts\ | |||
| before the client gives up. Defaults to 3. | |||
| :type num_retries: int | |||
| :param timeout: (Optional) Number of seconds to timout connection attempts\ | |||
| :param timeout: (Optional) Number of seconds to timeout connection attempts\ | |||
| before the client gives up. Defaults to 10. | |||
There was a problem hiding this comment.
Is there a placeholder we can specify here that autofills the default value when docs are generated? Like a :default: or something. That would be better than having to update the default value both in the method signature and in the docstring when/if it changes.
There was a problem hiding this comment.
I'm afraid not.
Best there is is autoattribute for class attributes but it doesn't work for function keyword arguments.
|
Thanks, looks good. The timeout's default value is actually OS dependent - 10 on my system but better to have it explicit. |
pkittenis
added a commit
that referenced
this pull request
Mar 31, 2015
Fixed docstring typo - set default timeout value explicitly.
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.
Fixed a minor typo and set the
timeoutparameter default to match what was in the doc string.