DOC: Fixed PeriodArray api ref #25526
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
Codecov Report
@@ Coverage Diff @@
## master #25526 +/- ##
=======================================
Coverage 91.75% 91.75%
=======================================
Files 173 173
Lines 52960 52960
=======================================
Hits 48595 48595
Misses 4365 4365
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #25526 +/- ##
==========================================
- Coverage 91.26% 91.26% -0.01%
==========================================
Files 173 173
Lines 52966 52966
==========================================
- Hits 48338 48337 -1
- Misses 4628 4629 +1
Continue to review full report at Codecov.
|
|
The linter complained about the ref to I'm not sure if just |
pandas/core/arrays/period.py
Outdated
| @@ -104,13 +104,15 @@ class PeriodArray(dtl.DatetimeLikeArrayMixin, dtl.DatelikeOps): | |||
| is an ndarray of integers, when `freq` is required. When `values` | |||
| is a PeriodArray (or box around), it's checked that ``values.freq`` | |||
| matches `freq`. | |||
| dtype : PeriodDtype, optional | |||
| A PeriodDtype instance from which to extract a `freq`. | |||
There was a problem hiding this comment.
Does it override the freq keyword?
|
We raise when they're both specified but differ.
…On Mon, Mar 4, 2019 at 9:28 AM Joris Van den Bossche < ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In pandas/core/arrays/period.py
<#25526 (comment)>:
> @@ -104,13 +104,15 @@ class PeriodArray(dtl.DatetimeLikeArrayMixin, dtl.DatelikeOps):
is an ndarray of integers, when `freq` is required. When `values`
is a PeriodArray (or box around), it's checked that ``values.freq``
matches `freq`.
+ dtype : PeriodDtype, optional
+ A PeriodDtype instance from which to extract a `freq`.
Does it override the freq keyword?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#25526 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ABQHIhkKPwxaercj38o-APIELZZ3Rp51ks5vTTulgaJpZM4bbNaz>
.
|
Can you then mention this in the docstring you added? |
jreback
reviewed
Mar 10, 2019
| @@ -104,13 +104,16 @@ class PeriodArray(dtl.DatetimeLikeArrayMixin, dtl.DatelikeOps): | |||
| is an ndarray of integers, when `freq` is required. When `values` | |||
| is a PeriodArray (or box around), it's checked that ``values.freq`` | |||
| matches `freq`. | |||
| dtype : PeriodDtype, optional | |||
| A PeriodDtype instance from which to extract a `freq`. If both | |||
| `freq` and `dtype` are specified, then the frequencies must match. | |||
| copy : bool, default False | |||
There was a problem hiding this comment.
so maybe a Raises section showing IncompatibleFrequecy
|
thanks @TomAugspurger |
sighingnow
added a commit
to sighingnow/pandas
that referenced
this pull request
Mar 20, 2019
* origin/master: DOC: clean bug fix section in whatsnew (pandas-dev#25792) DOC: Fixed PeriodArray api ref (pandas-dev#25526) Move locale code out of tm, into _config (pandas-dev#25757) Unpin pycodestyle (pandas-dev#25789) Add test for rdivmod on EA array (GH23287) (pandas-dev#24047) ENH: Support datetime.timezone objects (pandas-dev#25065) Cython language level 3 (pandas-dev#24538) API: concat on sparse values (pandas-dev#25719) TST: assert_produces_warning works with filterwarnings (pandas-dev#25721) make core.config self-contained (pandas-dev#25613) CLN: replace %s syntax with .format in pandas.io.parsers (pandas-dev#24721) TST: Check pytables<3.5.1 when skipping (pandas-dev#25773) DOC: Fix typo in docstring of DataFrame.memory_usage (pandas-dev#25770) Replace dicts with OrderedDicts in groupby aggregation functions (pandas-dev#25693) TST: Fixturize tests/frame/test_missing.py (pandas-dev#25640) DOC: Improve the docsting of Series.iteritems (pandas-dev#24879) DOC: Fix function name. (pandas-dev#25751) Implementing iso_week_year support for to_datetime (pandas-dev#25541) DOC: clarify corr behaviour when using a callable (pandas-dev#25732) remove unnecessary check_output (pandas-dev#25755) # Conflicts: # doc/source/whatsnew/v0.25.0.rst
thoo
added a commit
to thoo/pandas
that referenced
this pull request
Mar 20, 2019
* upstream/master: (55 commits) PERF: Improve performance of StataReader (pandas-dev#25780) Speed up tokenizing of a row in csv and xstrtod parsing (pandas-dev#25784) BUG: Fix _binop for operators for serials which has more than one returns (divmod/rdivmod). (pandas-dev#25588) BUG-24971 copying blocks also considers ndim (pandas-dev#25521) CLN: Panel reference from documentation (pandas-dev#25649) ENH: Quoting column names containing spaces with backticks to use them in query and eval. (pandas-dev#24955) BUG: reading windows utf8 filenames in py3.6 (pandas-dev#25769) DOC: clean bug fix section in whatsnew (pandas-dev#25792) DOC: Fixed PeriodArray api ref (pandas-dev#25526) Move locale code out of tm, into _config (pandas-dev#25757) Unpin pycodestyle (pandas-dev#25789) Add test for rdivmod on EA array (GH23287) (pandas-dev#24047) ENH: Support datetime.timezone objects (pandas-dev#25065) Cython language level 3 (pandas-dev#24538) API: concat on sparse values (pandas-dev#25719) TST: assert_produces_warning works with filterwarnings (pandas-dev#25721) make core.config self-contained (pandas-dev#25613) CLN: replace %s syntax with .format in pandas.io.parsers (pandas-dev#24721) TST: Check pytables<3.5.1 when skipping (pandas-dev#25773) DOC: Fix typo in docstring of DataFrame.memory_usage (pandas-dev#25770) ...
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.
[ci skip]
DatetimeArray was listed twice. PeriodArray was missed.