Separate method headers in docstrings #265
Open
+96
−82
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
The equal sign implies that there's a default value, which implies that the argument is optional.
For Downloads.download
For request(), move list of argument types to own list
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #265 +/- ##
=======================================
Coverage 90.68% 90.68%
=======================================
Files 5 5
Lines 612 612
=======================================
Hits 555 555
Misses 57 57 ☔ View full report in Codecov by Sentry. |
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.
The current method headers in the docstrings are a bit overburdened because they also list all the arguments' type information. For
download(), the argument explanation and list is mixed together for better flow, and forrequestit's separated to after the method description.This PR mostly moves around the lines, and doesn't add much in the way of content. Some of the arguments in the
download()docstring could probably use a sentence or two of description, but I'm being a bit more conservative in this PR.