DOC: Fix docstrings lack of punctuation #28031
Merged
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 pandasgit diff upstream/master -u -- "*.py" | flake8 --diffSimilar 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.