-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Fix GL01 and GL02 errors in the docstrings #27988
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
2a8dd19
style: Docstring text should be on the next line after opening `"""` …
steveayers124 318bd9a
style: Docstring text should be on the next line after opening `"""` …
steveayers124 65f2b43
style: remove white space on blank line #934 in pandas/util/testing.py
steveayers124 86381ec
style: Docstring text should be on the next line after opening `"""` …
steveayers124 c6dd333
style: Docstring text should be on the next line after opening `"""` …
steveayers124 ced6b62
style: Docstring text should be on the next line after opening `"""` …
steveayers124 eed4f9b
Merge remote-tracking branch 'upstream/master'
steveayers124 397f265
DOC: revert to previous indentation level of docstring, position 0
steveayers124 1284936
DOC: Going at this a bit more slowly, back out changes that caused th…
steveayers124 99b58bd
DOC: fix a couple PR08 and PR09 type errors while I'm in the code
steveayers124 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -123,18 +123,22 @@ def ip(): | |
|
||
@pytest.fixture(params=[True, False, None]) | ||
def observed(request): | ||
""" pass in the observed keyword to groupby for [True, False] | ||
""" | ||
Pass in the observed keyword to groupby for [True, False] | ||
This indicates whether categoricals should return values for | ||
values which are not in the grouper [False / None], or only values which | ||
appear in the grouper [True]. [None] is supported for future compatibility | ||
if we decide to change the default (and would need to warn if this | ||
parameter is not passed)""" | ||
parameter is not passed). | ||
""" | ||
return request.param | ||
|
||
|
||
@pytest.fixture(params=[True, False, None]) | ||
def ordered_fixture(request): | ||
"""Boolean 'ordered' parameter for Categorical.""" | ||
""" | ||
Boolean 'ordered' parameter for Categorical. | ||
""" | ||
return request.param | ||
|
||
|
||
|
@@ -234,15 +238,16 @@ def cython_table_items(request): | |
|
||
|
||
def _get_cython_table_params(ndframe, func_names_and_expected): | ||
"""combine frame, functions from SelectionMixin._cython_table | ||
""" | ||
Combine frame, functions from SelectionMixin._cython_table | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Short description should be one line |
||
keys and expected result. | ||
|
||
Parameters | ||
---------- | ||
ndframe : DataFrame or Series | ||
func_names_and_expected : Sequence of two items | ||
The first item is a name of a NDFrame method ('sum', 'prod') etc. | ||
The second item is the expected return value | ||
The second item is the expected return value. | ||
|
||
Returns | ||
------- | ||
|
@@ -341,7 +346,8 @@ def strict_data_files(pytestconfig): | |
|
||
@pytest.fixture | ||
def datapath(strict_data_files): | ||
"""Get the path to a data file. | ||
""" | ||
Get the path to a data file. | ||
|
||
Parameters | ||
---------- | ||
|
@@ -375,7 +381,9 @@ def deco(*args): | |
|
||
@pytest.fixture | ||
def iris(datapath): | ||
"""The iris dataset as a DataFrame.""" | ||
""" | ||
The iris dataset as a DataFrame. | ||
""" | ||
return pd.read_csv(datapath("data", "iris.csv")) | ||
|
||
|
||
|
@@ -504,7 +512,8 @@ def tz_aware_fixture(request): | |
|
||
@pytest.fixture(params=STRING_DTYPES) | ||
def string_dtype(request): | ||
"""Parametrized fixture for string dtypes. | ||
""" | ||
Parametrized fixture for string dtypes. | ||
|
||
* str | ||
* 'str' | ||
|
@@ -515,7 +524,8 @@ def string_dtype(request): | |
|
||
@pytest.fixture(params=BYTES_DTYPES) | ||
def bytes_dtype(request): | ||
"""Parametrized fixture for bytes dtypes. | ||
""" | ||
Parametrized fixture for bytes dtypes. | ||
|
||
* bytes | ||
* 'bytes' | ||
|
@@ -525,7 +535,8 @@ def bytes_dtype(request): | |
|
||
@pytest.fixture(params=OBJECT_DTYPES) | ||
def object_dtype(request): | ||
"""Parametrized fixture for object dtypes. | ||
""" | ||
Parametrized fixture for object dtypes. | ||
|
||
* object | ||
* 'object' | ||
|
@@ -535,7 +546,8 @@ def object_dtype(request): | |
|
||
@pytest.fixture(params=DATETIME64_DTYPES) | ||
def datetime64_dtype(request): | ||
"""Parametrized fixture for datetime64 dtypes. | ||
""" | ||
Parametrized fixture for datetime64 dtypes. | ||
|
||
* 'datetime64[ns]' | ||
* 'M8[ns]' | ||
|
@@ -545,7 +557,8 @@ def datetime64_dtype(request): | |
|
||
@pytest.fixture(params=TIMEDELTA64_DTYPES) | ||
def timedelta64_dtype(request): | ||
"""Parametrized fixture for timedelta64 dtypes. | ||
""" | ||
Parametrized fixture for timedelta64 dtypes. | ||
|
||
* 'timedelta64[ns]' | ||
* 'm8[ns]' | ||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think need a blank line separating short description from long description here