Corrects docstring for the as_df keyword
#183
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
The specific behavior of the `as_df` keyword stated in the docstring template for specific fields is contrary to the keyword's main description, the keyword meaning and to its actual behavior: `as_df=false` for plain arrays, `as_df=true` for dataframes.
Codecov Report
@@ Coverage Diff @@
## master #183 +/- ##
=======================================
Coverage 36.29% 36.29%
=======================================
Files 43 43
Lines 2240 2240
=======================================
Hits 813 813
Misses 1427 1427
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
|
thanks! |
|
yrw :D |
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 specific behavior of the
as_dfkeyword stated in the docstring template for specific fields is contrary to the keyword's main description, the keyword meaning and to its actual behavior:as_df=falsefor plain arrays,as_df=truefor dataframes.