DOC: Fixed PR06 docstrings errors in pandas.timedelta_range #28719
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
|
LGTM |
simonjayhawkins
requested changes
Oct 1, 2019
pandas/core/indexes/timedeltas.py
Outdated
| @@ -709,25 +711,30 @@ def _is_convertible_to_index(other): | |||
|
|
|||
|
|
|||
| def timedelta_range( | |||
| start=None, end=None, periods=None, freq=None, name=None, closed=None | |||
| ): | |||
| start: Optional[str] = None, | |||
There was a problem hiding this comment.
from the docstring this str or timedelta-like.
I would only add types for the pure str, boolean or int types here and do the more complex typing in a separate PR.
There was a problem hiding this comment.
The issue is that, when I use pure str and int types, mypy fails with this error:
pandas/core/indexes/timedeltas.py:711: error: Incompatible default for argument "start" (default has type "None", argument has type "str")
pandas/core/indexes/timedeltas.py:711: error: Incompatible default for argument "end" (default has type "None", argument has type "str")
pandas/core/indexes/timedeltas.py:711: error: Incompatible default for argument "periods" (default has type "None", argument has type "int")
pandas/core/indexes/timedeltas.py:711: error: Incompatible default for argument "freq" (default has type "None", argument has type "str")
pandas/core/indexes/timedeltas.py:711: error: Incompatible default for argument "name" (default has type "None", argument has type "str")
pandas/core/indexes/timedeltas.py:711: error: Incompatible default for argument "closed" (default has type "None", argument has type "str")
which is why I've removed typing in my last commit. Thus, this PR only deals with the PR06 docs errors.
There was a problem hiding this comment.
Thus, this PR only deals with the PR06 docs errors.
no problem. lets keep typing separate for now.
simonjayhawkins
approved these changes
Oct 2, 2019
|
Thanks @LauraCollard ! |
galuhsahid
added a commit
to galuhsahid/pandas
that referenced
this pull request
Oct 4, 2019
* master: (22 commits) DOC: fix PR09,PR08 errors for pandas.Timestamp (pandas-dev#28739) WEB: Add diversity note to team.md (pandas-dev#28630) DOC: Minor fixes in pandas/testing.py docstring. (pandas-dev#28752) TST: port maybe_promote tests from pandas-dev#23982 (pandas-dev#28764) Bugfix/groupby datetime issue (pandas-dev#28569) reenable codecov (pandas-dev#28750) CLN: Centralised _check_percentile (pandas-dev#27584) DEPR: Deprecate Index.set_value (pandas-dev#28621) CLN: Fix typo in contributing.rst (pandas-dev#28761) Fixed docstring errors in pandas.period range and pandas.PeriodIndex (pandas-dev#28756) BUG: Fix TypeError raised in libreduction (pandas-dev#28643) DOC: Pandas.Series.drop docstring PR02 (pandas-dev#27976) (pandas-dev#28742) DOC: Fixed doctring errors PR08, PR09 in pandas.io (pandas-dev#28748) TST: Fix broken test cases where Timedelta/Timestamp raise (pandas-dev#28729) REF: Consolidate alignment calls in DataFrame ops (pandas-dev#28638) BUG: Fix dep generation (pandas-dev#28734) Added doctstring to fixture (pandas-dev#28727) DOC: Fixed PR06 docstrings errors in pandas.timedelta_range (pandas-dev#28719) replaced safe_import with a corresponding test decorator (pandas-dev#28731) BUG: Fix RangeIndex.get_indexer for decreasing RangeIndex (pandas-dev#28680) ...
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
bongolegend
pushed a commit
to bongolegend/pandas
that referenced
this pull request
Jan 1, 2020
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 pandasgit diff upstream/master -u -- "*.py" | flake8 --diff