-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Fix docstrings lack of punctuation #28031
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
jorisvandenbossche
merged 14 commits into
pandas-dev:master
from
martinagvilas:fix-docstrings-punctuation
Aug 23, 2019
Merged
DOC: Fix docstrings lack of punctuation #28031
jorisvandenbossche
merged 14 commits into
pandas-dev:master
from
martinagvilas:fix-docstrings-punctuation
Aug 23, 2019
Conversation
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
datapythonista
approved these changes
Aug 20, 2019
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.
lgtm, great job @martinagvilas, and thanks for taking care of those.
jorisvandenbossche
approved these changes
Aug 23, 2019
@martinagvilas Thanks a lot! |
galuhsahid
pushed a commit
to galuhsahid/pandas
that referenced
this pull request
Aug 25, 2019
galuhsahid
added a commit
to galuhsahid/pandas
that referenced
this pull request
Aug 25, 2019
* master: (40 commits) DOC: Fix GL01 and GL02 errors in the docstrings (pandas-dev#27988) Remove Encoding of values in char** For Labels (pandas-dev#27618) TYPING: more type hints for io.formats.printing (pandas-dev#27765) TST: fix compression tests when run without virtualenv/condaenv (pandas-dev#28051) DOC: Start 0.25.2 (pandas-dev#28111) DOC: Fix docstrings lack of punctuation (pandas-dev#28031) DOC: Remove alias for numpy.random.randn from the docs (pandas-dev#28082) DOC: update GroupBy.head()/tail() documentation (pandas-dev#27844) BUG: timedelta merge asof with tolerance (pandas-dev#27650) BUG: Series.rename raises error on values accepted by Series construc… (pandas-dev#27814) Preserve index when setting new column on empty dataframe. (pandas-dev#26471) BUG: Fixed groupby quantile for listlike q (pandas-dev#27827) BUG: iter with readonly values, closes pandas-dev#28055 (pandas-dev#28074) TST: non-strict xfail for period test (pandas-dev#28072) DOC: Update whatsnew (pandas-dev#28073) CI: disable codecov (pandas-dev#28065) CI: Set SHA for codecov upload (pandas-dev#28067) BUG: Correct the previous bug fixing on xlim for plotting (pandas-dev#28059) CI: Add pip dependence explicitly (pandas-dev#28008) DOC: Change document code prun in a row (pandas-dev#28029) ...
proost
pushed a commit
to proost/pandas
that referenced
this pull request
Dec 19, 2019
proost
pushed a commit
to proost/pandas
that referenced
this pull request
Dec 19, 2019
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.
black pandas
git diff upstream/master -u -- "*.py" | flake8 --diff
Similar to issue #27979, and as pointed out by @datapythonista, the summaries of some dosctrings don’t end with a period.
I added the period to the following cases:
These are the outputs of validate_docstrings.py when evaluating each case:
pandas.IndexSlice
pandas.MultiIndex.names
pandas.MultiIndex.is_lexsorted
pandas.MultiIndex.reorder_levels
pandas.DatetimeIndex.snap
pandas.DatetimeIndex.to_perioddelta
pandas.DatetimeIndex.to_pydatetime
pandas.DatetimeIndex.to_series
pandas.TimedeltaIndex
pandas.PeriodIndex.is_leap_year
pandas.api.extensions.ExtensionArray._concat_same_type
pandas.api.extensions.ExtensionArray.dropna
I would be happy to also work on the other errors/warnings in this PR on another.