Split (1)

validation · 56.7k rows

title stringlengths 1 185	diff stringlengths 0 32.2M	body stringlengths 0 123k ⌀	url stringlengths 57 58	created_at stringlengths 20 20	closed_at stringlengths 20 20	merged_at stringlengths 20 20 ⌀	updated_at stringlengths 20 20
DOC: update the pandas.Series/DataFrame.interpolate docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index fd372ce2fd78e..9bdf34113ccf0 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -6081,89 +6081,191 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None, _shared_docs['interpolate'] = """ Please not...	- [x] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" \| flake8 --diff` - [x] The html version looks good: `python doc/make.py --si...	https://api.github.com/repos/pandas-dev/pandas/pulls/20270	2018-03-11T02:12:06Z	2018-08-19T00:39:00Z	2018-08-19T00:39:00Z	2020-03-31T05:51:35Z
DOC: update NDFrame.squeeze docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 397726181d2fb..7a5c3989089cc 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -699,18 +699,108 @@ def pop(self, item): def squeeze(self, axis=None): """ - Squeeze length 1 dimensions. + Squeeze 1 dimensio...	## Series.squeeze and DataFrame.squeeze are inherited from NDFrame - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" \| flak...	https://api.github.com/repos/pandas-dev/pandas/pulls/20269	2018-03-11T02:03:28Z	2018-07-07T17:37:15Z	2018-07-07T17:37:15Z	2018-07-07T17:37:15Z
DOC: add documentation to core.window.corr	diff --git a/pandas/core/window.py b/pandas/core/window.py index f089e402261db..1029b96c58475 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -1391,19 +1391,113 @@ def _get_cov(X, Y): _get_cov, pairwise=bool(pairwise)) _shared_docs['corr'] = dedent(""" - %...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [ ] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ ] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20268	2018-03-11T01:48:18Z	2018-07-08T14:35:15Z	2018-07-08T14:35:15Z	2018-07-08T14:35:22Z
DOC: Improve the docstring of pandas.DataFrame.append()	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 66f51cd0dae45..fa720bb38213f 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -145,8 +145,11 @@ Parameters ----------%s -right : DataFrame +right : DataFrame, Series or dict + Object to merge with. how : {'left', 'right', 'outer', 'in...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20267	2018-03-11T01:14:47Z	2018-07-08T16:28:27Z	2018-07-08T16:28:27Z	2018-07-08T16:28:35Z
DOC: update the pandas.core.window.x.mean docstring	diff --git a/pandas/core/window.py b/pandas/core/window.py index c41b07759d555..9e7ed5721cab5 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -323,7 +323,48 @@ def aggregate(self, arg, args, *kwargs): %(name)s sum""") _shared_docs['mean'] = dedent(""" - %(name)s mean""") + Calculat...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20265	2018-03-11T00:06:00Z	2018-03-17T12:30:10Z	2018-03-17T12:30:09Z	2018-03-17T12:30:15Z
DOC" update the Pandas core window rolling count docstring"	diff --git a/pandas/core/window.py b/pandas/core/window.py index c41b07759d555..14a0b851d0470 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -780,8 +780,43 @@ def calc(x): class _Rolling_and_Expanding(_Rolling): - _shared_docs['count'] = """%(name)s count of number of non-NaN - observation...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [ ] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ ] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20264	2018-03-11T00:05:46Z	2018-03-19T21:13:23Z	2018-03-19T21:13:23Z	2018-03-19T21:13:32Z
DOC: update the window.Rolling.min docstring	diff --git a/pandas/core/window.py b/pandas/core/window.py index 358ef98e1c072..84bbfb3c8ba4a 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -910,7 +910,38 @@ def max(self, args, kwargs): return self._apply('roll_max', 'max', *kwargs) _shared_docs['min'] = dedent(""" - %(name)s...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [ ] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ ] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20263	2018-03-11T00:01:50Z	2018-03-17T11:49:31Z	2018-03-17T11:49:31Z	2018-03-17T11:49:44Z
DOC: update pandas.DataFrame.head docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 397726181d2fb..f25d2d5164a84 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -3607,8 +3607,8 @@ def head(self, n=5): """ Return the first `n` rows. - This function returns the first `n` rows for the object ...	-Update wording to be accurate and match pandas.DataFrame.tail docstring Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X ] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <you...	https://api.github.com/repos/pandas-dev/pandas/pulls/20262	2018-03-10T23:38:46Z	2018-03-11T11:50:19Z	2018-03-11T11:50:19Z	2018-03-12T13:10:58Z
DOC: Update pandas.Series.copy docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index d5bdeb7fe1a4d..a65c2cd8df350 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -4506,22 +4506,108 @@ def astype(self, dtype, copy=True, errors='raise', **kwargs): def copy(self, deep=True): """ - Make a copy of t...	Closes https://github.com/pandas-dev/pandas/issues/19505 - Add extended summary - Add examples Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/va...	https://api.github.com/repos/pandas-dev/pandas/pulls/20261	2018-03-10T23:06:04Z	2018-03-23T08:52:05Z	2018-03-23T08:52:05Z	2018-09-29T02:40:56Z
DOC: Improve the docstring of pandas.core.window.Rolling.median	diff --git a/pandas/core/window.py b/pandas/core/window.py index c41b07759d555..538b09929b744 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -850,7 +850,38 @@ def mean(self, args, kwargs): return self._apply('roll_mean', 'mean', *kwargs) _shared_docs['median'] = dedent(""" - %(...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20260	2018-03-10T23:02:57Z	2018-03-13T12:58:39Z	2018-03-13T12:58:39Z	2018-03-13T13:04:25Z
DOC: update the docstring of pandas.DataFrame.from_dict	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..d3a170a6260a3 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -883,27 +883,66 @@ def dot(self, other): @classmethod def from_dict(cls, data, orient='columns', dtype=None, columns=None): """ - Construc...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20259	2018-03-10T22:52:11Z	2018-03-11T14:40:02Z	2018-03-11T14:40:02Z	2018-03-11T14:40:07Z
DOC: update the docstring of pandas.Series.clip	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 397726181d2fb..3144cfc2fb4da 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -5605,53 +5605,79 @@ def clip(self, lower=None, upper=None, axis=None, inplace=False, """ Trim values at input threshold(s). + As...	Continuation of https://github.com/pandas-dev/pandas/pull/20178 Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function...	https://api.github.com/repos/pandas-dev/pandas/pulls/20256	2018-03-10T22:23:57Z	2018-03-15T14:36:23Z	2018-03-15T14:36:23Z	2018-03-15T14:36:23Z
DOC: Improve the docstring of DataFrame.nlargest	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..b2ef75ab7fdce 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -3835,34 +3835,93 @@ def sortlevel(self, level=0, axis=0, ascending=True, inplace=False, inplace=inplace, sort_remaining=sort_remain...	Co-authored-by: Igor C. A. de Lima <igorcadelima@gmail.com> Signed-off-by: Carlos Eduardo Moreira dos Santos <cems@cemshost.com.br> Signed-off-by: Igor C. A. de Lima <igorcadelima@gmail.com> Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: up...	https://api.github.com/repos/pandas-dev/pandas/pulls/20255	2018-03-10T22:17:08Z	2018-03-17T10:29:42Z	2018-03-17T10:29:42Z	2018-03-17T10:30:21Z
DOC: Improve the docstring of DataFrame.transpose()	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 57aba8078f3c5..8ff2b6c85eeed 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -2289,7 +2289,100 @@ def memory_usage(self, index=True, deep=False): return result def transpose(self, args, *kwargs): - """Transpose index...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20254	2018-03-10T22:16:03Z	2018-03-23T08:36:09Z	2018-03-23T08:36:09Z	2018-03-23T08:36:37Z
DOC: update the `to_pickle` & `read_pickle` docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9f2112729a503..3cd1906b3a557 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -1901,14 +1901,15 @@ def to_sql(self, name, con, schema=None, if_exists='fail', index=True, def to_pickle(self, path, compression='infer', ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20253	2018-03-10T22:13:34Z	2018-03-14T08:32:06Z	2018-03-14T08:32:06Z	2018-03-14T09:13:27Z
DOC: update the DataFrame.pivot docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..bc224eba02b9e 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -4341,44 +4341,55 @@ def last_valid_index(self): def pivot(self, index=None, columns=None, values=None): """ + Return reshaped DataFrame orga...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20250	2018-03-10T21:44:18Z	2018-03-12T20:47:50Z	2018-03-12T20:47:50Z	2018-03-12T20:48:00Z
DOC: update the Index.isin docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 366ebce9f0a7a..446b1b02706e3 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -3396,8 +3396,11 @@ def map(self, mapper, na_action=None): def isin(self, values, level=None): """ + Return a boo...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20249	2018-03-10T21:42:26Z	2018-03-18T21:40:04Z	2018-03-18T21:40:04Z	2018-03-19T13:46:09Z
DOC: update the pandas.Series.sort_index docstring	diff --git a/pandas/core/series.py b/pandas/core/series.py index 7b9b8a7a75008..7800b02a3fbe2 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -2016,10 +2016,118 @@ def _try_kind_sort(arr): else: return result.__finalize__(self) - @Appender(generic._shared_docs['sort_index'] ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20248	2018-03-10T21:39:45Z	2018-03-12T17:00:09Z	2018-03-12T17:00:09Z	2018-03-12T17:00:16Z
DOC: update Series.sort_values docstring	diff --git a/pandas/core/series.py b/pandas/core/series.py index 069f0372ab6e1..1e2ae673d3c4c 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -76,7 +76,7 @@ __all__ = ['Series'] _shared_doc_kwargs = dict( - axes='index', klass='Series', axes_single_arg="{0, 'index'}", + axes='index', klass='...	Co-authored-by: @marielen Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style che...	https://api.github.com/repos/pandas-dev/pandas/pulls/20247	2018-03-10T21:36:58Z	2018-03-12T14:59:55Z	2018-03-12T14:59:55Z	2018-03-12T15:00:07Z
DOC: update `pandas/core/ops.py` docstring template to accept examples	diff --git a/pandas/core/ops.py b/pandas/core/ops.py index 83879cdaaa63c..6c6a54993b669 100644 --- a/pandas/core/ops.py +++ b/pandas/core/ops.py @@ -343,50 +343,93 @@ def _get_op_name(op, special): # ----------------------------------------------------------------------------- # Docstring Generation and Templates +...	Checklist for the pandas documentation sprint - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" \| flake8 --diff` - [x] It has been proofread on language by another sprint participant The Chicago assigned docstrings u...	https://api.github.com/repos/pandas-dev/pandas/pulls/20246	2018-03-10T21:33:41Z	2018-03-11T13:51:25Z	2018-03-11T13:51:25Z	2018-03-15T08:53:45Z
DOC: update the DataFrame.cov docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..d8269b605eef9 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -5501,7 +5501,22 @@ def corr(self, method='pearson', min_periods=1): def cov(self, min_periods=None): """ - Compute pairwise covariance of co...	Update the docstring with some examples from elsewhere in the pandas documentation. Some of the examples use randomly generated time series because we need to get covariance between long series. Used a random seed to ensure that the results are the same each time. Checklist for the pandas documentation sprint...	https://api.github.com/repos/pandas-dev/pandas/pulls/20245	2018-03-10T21:31:01Z	2018-03-11T11:50:40Z	2018-03-11T11:50:40Z	2018-03-11T15:29:30Z
Doc: Updated DataFrame.dot docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..8a83eed0a801e 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -835,15 +835,82 @@ def __len__(self): def dot(self, other): """ - Matrix multiplication with DataFrame or Series objects + Find the do...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20243	2018-03-10T21:21:38Z	2018-03-13T15:50:45Z	null	2018-03-17T11:05:06Z
DOC: Update Series.repeat docstring	diff --git a/pandas/core/series.py b/pandas/core/series.py index 7b9b8a7a75008..f121c6a12c6bf 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -918,12 +918,53 @@ def _set_values(self, key, value): @deprecate_kwarg(old_arg_name='reps', new_arg_name='repeats') def repeat(self, repeats, args, ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [ X] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ X] The PEP8 style check passes: `git diff upstre...	https://api.github.com/repos/pandas-dev/pandas/pulls/20242	2018-03-10T21:16:40Z	2018-03-10T22:23:50Z	null	2018-03-10T22:59:53Z
DOC: update the DataFrame.mode method docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..d6b16e6cb4ad8 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -12,8 +12,8 @@ # pylint: disable=E1101,E1103 # pylint: disable=W0212,W0231,W0703,W0622 -import functools import collections +import functools import itertools...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20241	2018-03-10T21:15:48Z	2018-08-17T20:32:38Z	null	2023-05-11T01:17:33Z
API: Return Index from DatetimeIndex/PeriodIndex.strftime	diff --git a/doc/source/whatsnew/v0.23.0.txt b/doc/source/whatsnew/v0.23.0.txt index e838afdbbd083..31735063dc687 100644 --- a/doc/source/whatsnew/v0.23.0.txt +++ b/doc/source/whatsnew/v0.23.0.txt @@ -713,6 +713,7 @@ Other API Changes - ``Categorical.fillna`` now validates its ``value`` and ``method`` keyword argument...	- [x] closes #20127 - [x] tests added / passed - [x] passes `git diff upstream/master -u -- "*.py" \| flake8 --diff` - [x] whatsnew entry I will update the docstring after #20103 is merged.	https://api.github.com/repos/pandas-dev/pandas/pulls/20240	2018-03-10T21:12:11Z	2018-03-16T22:01:39Z	2018-03-16T22:01:39Z	2018-03-17T23:02:15Z
Docstring pandas.series.diff	diff --git a/pandas/core/series.py b/pandas/core/series.py index 7b9b8a7a75008..a3e4c3bb30346 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -1607,16 +1607,63 @@ def cov(self, other, min_periods=None): def diff(self, periods=1): """ - 1st discrete difference of object + ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20238	2018-03-10T21:11:32Z	2018-03-11T14:17:06Z	2018-03-11T14:17:06Z	2018-03-11T14:17:13Z
DOC: update the DataFrame.combine and DataFrame.combine_first docstrings	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 06e3b982742b2..97592ab75845a 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -4894,19 +4894,26 @@ def _compare(a, b): def combine(self, other, func, fill_value=None, overwrite=True): """ - Add two DataFrame objects and...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstre...	https://api.github.com/repos/pandas-dev/pandas/pulls/20237	2018-03-10T21:04:46Z	2018-07-07T22:17:30Z	2018-07-07T22:17:30Z	2018-07-07T22:17:30Z
DOC: update the pandas.DataFrame.plot.density docstring	diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index 520c6cecce6d7..f587cb91ab932 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -1380,6 +1380,50 @@ def orientation(self): return 'vertical' +_kde_docstring = """ + Generate Kernel Density Estimate plot u...	This docstring is quite similar to the one of #20041. Unfortunately, I was not able to compute a kernel estimate of a two-dimensional random variable. Hence, the example is more of an analysis of some independent data series. Checklist for the pandas documentation sprint (ignore this if you are doing an unrela...	https://api.github.com/repos/pandas-dev/pandas/pulls/20236	2018-03-10T21:03:42Z	2018-03-11T21:37:38Z	2018-03-11T21:37:38Z	2018-03-11T21:37:53Z
DOC: update Rolling.std docstring	diff --git a/pandas/core/window.py b/pandas/core/window.py index c41b07759d555..b5d386eff2423 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -857,13 +857,62 @@ def median(self, kwargs): return self._apply('roll_median_c', 'median', kwargs) _shared_docs['std'] = dedent(""" - %(n...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20235	2018-03-10T20:51:23Z	2018-03-12T16:04:20Z	2018-03-12T16:04:20Z	2018-03-12T16:11:11Z
DOC: update the PeriodIndex docstring	diff --git a/pandas/core/indexes/period.py b/pandas/core/indexes/period.py index 705dc36d92522..f8cff437e8781 100644 --- a/pandas/core/indexes/period.py +++ b/pandas/core/indexes/period.py @@ -133,29 +133,43 @@ class PeriodIndex(DatelikeOps, DatetimeIndexOpsMixin, Int64Index): Parameters ---------- data ...	year, month, quarter, day, hour, minute, second documentation improved. Detailed in depth the requirements of each parameter. Documentation is still confusing for allowable freq arguments Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: upd...	https://api.github.com/repos/pandas-dev/pandas/pulls/20234	2018-03-10T20:35:25Z	2018-11-01T01:35:54Z	null	2018-11-01T01:35:54Z
DOC: update the Rolling.var docstring	diff --git a/pandas/core/window.py b/pandas/core/window.py index c41b07759d555..40b94d2fe2507 100644 --- a/pandas/core/window.py +++ b/pandas/core/window.py @@ -879,13 +879,62 @@ def f(arg, args, kwargs): ddof=ddof, *kwargs) _shared_docs['var'] = dedent(""" - %(name)s variance ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20233	2018-03-10T20:30:28Z	2018-03-12T17:07:52Z	2018-03-12T17:07:52Z	2018-03-12T17:08:03Z
DOC: update the pd.Index.argsort docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index fd1d3690e8a89..5edb031c7442c 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -2316,16 +2316,38 @@ def shift(self, periods=1, freq=None): def argsort(self, args, *kwargs): """ - Returns the...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20232	2018-03-10T20:28:49Z	2018-03-12T17:17:34Z	2018-03-12T17:17:34Z	2018-03-12T17:17:51Z
DOC: update the Index.get_values docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index fd1d3690e8a89..42a863a64ad04 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -681,7 +681,47 @@ def _values(self): return self.values def get_values(self): - """ return the underlying data as...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20231	2018-03-10T20:21:29Z	2018-03-11T17:56:01Z	2018-03-11T17:56:01Z	2018-03-11T18:13:06Z
DOC: update the pandas.Series.dt.dayofweek docstring	diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index e5e9bba269fd4..aeac5e03de54a 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1707,8 +1707,67 @@ def freq(self, value): weekofyear = _field_accessor('weekofyear', 'woy', ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20230	2018-03-10T20:18:33Z	2018-07-08T23:06:51Z	null	2018-07-08T23:06:51Z
DOC: update the DataFrame.loc[] docstring	diff --git a/pandas/core/indexing.py b/pandas/core/indexing.py index ec2874b3bae95..e78b2bcf28d25 100755 --- a/pandas/core/indexing.py +++ b/pandas/core/indexing.py @@ -1413,7 +1413,8 @@ def _get_slice_axis(self, slice_obj, axis=None): class _LocIndexer(_LocationIndexer): - """Purely label-location based indexe...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20229	2018-03-10T20:08:39Z	2018-03-14T13:00:47Z	2018-03-14T13:00:47Z	2018-03-14T13:30:57Z
DOC:Improve the docstring of DataFrame.iloc()	diff --git a/pandas/core/indexing.py b/pandas/core/indexing.py index a69313a2d4a43..80396a9149d5a 100755 --- a/pandas/core/indexing.py +++ b/pandas/core/indexing.py @@ -1924,7 +1924,8 @@ def _getitem_axis(self, key, axis=None): class _iLocIndexer(_LocationIndexer): - """Purely integer-location based indexing fo...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X ] PR title is "DOC: update the <your-function-or-method> docstring" - [ X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ X] The PEP8 style check passes: `git diff upstr...	https://api.github.com/repos/pandas-dev/pandas/pulls/20228	2018-03-10T20:02:25Z	2018-07-07T21:22:35Z	2018-07-07T21:22:35Z	2018-07-07T21:22:35Z
Docstring pandas.data frame.diff	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..bf926e1bca147 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -4722,20 +4722,90 @@ def melt(self, id_vars=None, value_vars=None, var_name=None, def diff(self, periods=1, axis=0): """ - 1st discrete diffe...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20227	2018-03-10T20:00:48Z	2018-03-11T12:36:22Z	2018-03-11T12:36:22Z	2018-03-11T14:16:24Z
Series as of docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9f2112729a503..bc3c7d354a901 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -5401,40 +5401,59 @@ def interpolate(self, method='linear', axis=0, limit=None, inplace=False, def asof(self, where, subset=None): """ - ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [ ] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ ] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20226	2018-03-10T19:53:24Z	2018-08-22T10:27:08Z	null	2018-08-22T10:27:08Z
DOC: Update pandas.DataFrame.tail docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index d5bdeb7fe1a4d..a6b7a3d6cd02a 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -3660,7 +3660,11 @@ def head(self, n=5): def tail(self, n=5): """ - Return the last n rows. + Return the last `n` rows. + + ...	-Add extended summary Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check p...	https://api.github.com/repos/pandas-dev/pandas/pulls/20225	2018-03-10T19:46:11Z	2018-03-11T11:50:55Z	2018-03-11T11:50:55Z	2018-03-12T13:10:54Z
DOC: update the IntervalIndex.from_array docstring	diff --git a/pandas/core/indexes/interval.py b/pandas/core/indexes/interval.py index ccf2e5e3c4486..54800d0d76d2e 100644 --- a/pandas/core/indexes/interval.py +++ b/pandas/core/indexes/interval.py @@ -457,7 +457,7 @@ def from_breaks(cls, breaks, closed='right', name=None, copy=False, def from_arrays(cls, left, rig...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20224	2018-03-10T19:42:44Z	2018-03-13T20:09:54Z	2018-03-13T20:09:54Z	2018-03-13T20:10:16Z
DOC: add docstring for Index.get_duplicates	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index fd1d3690e8a89..e47854d94542e 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1710,6 +1710,59 @@ def _invalid_indexer(self, form, key): kind=type(key))) def get_duplicates(self)...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20223	2018-03-10T19:40:47Z	2018-03-11T14:33:55Z	2018-03-11T14:33:55Z	2018-03-13T08:34:24Z
DOC: Improve the docstring of DataFrame.describe()	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index c1964025eff26..a75e3960cda16 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -8348,7 +8348,7 @@ def abs(self): def describe(self, percentiles=None, include=None, exclude=None): """ - Generates descriptive stati...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20222	2018-03-10T19:23:53Z	2018-07-08T12:59:44Z	2018-07-08T12:59:44Z	2018-07-08T12:59:51Z
DOC: update the DataFrame.count docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..33156bcd381d3 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -5592,22 +5592,78 @@ def corrwith(self, other, axis=0, drop=False): def count(self, axis=0, level=None, numeric_only=False): """ - Return Ser...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20221	2018-03-10T19:17:07Z	2018-03-12T14:24:51Z	2018-03-12T14:24:51Z	2018-03-13T20:00:49Z
DOC: update the Series.view docstring	diff --git a/pandas/core/series.py b/pandas/core/series.py index 7b9b8a7a75008..1fce2097f745b 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -547,6 +547,71 @@ def __len__(self): return len(self._data) def view(self, dtype=None): + """ + Create a new view of the Series. +...	- [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" \| flake8 --diff` - [X] The html version looks good: `python doc/make.py --si...	https://api.github.com/repos/pandas-dev/pandas/pulls/20220	2018-03-10T19:16:21Z	2018-03-11T14:41:13Z	2018-03-11T14:41:13Z	2018-03-11T16:56:14Z
DOC: update the DataFrame.iat[] docstring	diff --git a/pandas/core/indexing.py b/pandas/core/indexing.py index ec2874b3bae95..560e7638b5510 100755 --- a/pandas/core/indexing.py +++ b/pandas/core/indexing.py @@ -1920,11 +1920,49 @@ def _convert_key(self, key, is_setter=False): class _iAtIndexer(_ScalarAccessIndexer): - """Fast integer location scalar ac...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20219	2018-03-10T19:13:50Z	2018-03-11T12:43:10Z	2018-03-11T12:43:10Z	2018-03-11T15:29:29Z
DOC: update the series.dt.weekofyear docstring	diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index 491fefe8efee0..d69119d757d70 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1706,9 +1706,69 @@ def freq(self, value): "The microseconds of the datetime") ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20218	2018-03-10T19:04:44Z	2018-11-03T05:45:59Z	null	2018-11-03T05:45:59Z
DOC: update the pandas.DataFrame.any docstring	diff --git a/.gitignore b/.gitignore index 00dac6e336c37..4bbbcad0c97ad 100644 --- a/.gitignore +++ b/.gitignore @@ -109,3 +109,4 @@ doc/tmp.sv doc/source/styled.xlsx doc/source/templates/ env/ +doc/source/savefig/ diff --git a/pandas/core/generic.py b/pandas/core/generic.py index fc8aaa23d2f79..23654613104ec 100644...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [+] PR title is "DOC: update the <your-function-or-method> docstring" - [+] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [+] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20217	2018-03-10T19:03:47Z	2018-03-12T16:52:31Z	2018-03-12T16:52:31Z	2018-03-12T16:52:32Z
DOC: update the pandas.DataFrame.all docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index d9bc4804b061b..fc8aaa23d2f79 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7584,11 +7584,10 @@ def _add_numeric_operations(cls): cls.any = _make_logical_function( cls, 'any', name, name2, axis_descr, ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20216	2018-03-10T19:02:32Z	2018-03-11T14:42:36Z	2018-03-11T14:42:36Z	2018-03-11T14:42:39Z
DOC: update the Series.sort_values docstring	diff --git a/pandas/core/series.py b/pandas/core/series.py index 069f0372ab6e1..f08554a0cba0f 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -76,7 +76,7 @@ __all__ = ['Series'] _shared_doc_kwargs = dict( - axes='index', klass='Series', axes_single_arg="{0, 'index'}", + axes='index', klass='...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ ] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20215	2018-03-10T18:59:46Z	2018-03-10T19:06:08Z	null	2018-03-11T15:30:58Z
DOC: Update the pandas.DataFrame.tail docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a893b2ba1a189..fdc57ec4ae973 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -3660,7 +3660,11 @@ def head(self, n=5): def tail(self, n=5): """ - Return the last n rows. + Return the last `n` rows. + + ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20214	2018-03-10T18:53:31Z	2018-03-10T19:09:57Z	null	2018-03-10T19:09:58Z
DOC: Updated docstring DatetimeIndex.ceil	diff --git a/pandas/core/indexes/datetimelike.py b/pandas/core/indexes/datetimelike.py index e673bfe411cb4..24084ad5fba3b 100644 --- a/pandas/core/indexes/datetimelike.py +++ b/pandas/core/indexes/datetimelike.py @@ -121,6 +121,46 @@ def floor(self, freq): @Appender(_round_doc % "ceil") def ceil(self, freq)...	completed the DatetimeIndex.ceil Docstring. Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [ ] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ ] ...	https://api.github.com/repos/pandas-dev/pandas/pulls/20213	2018-03-10T18:48:51Z	2018-11-03T05:43:17Z	null	2018-11-03T05:43:17Z
DOC: update the pandas.DataFrame.clip docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9f2112729a503..6b79ed8028d24 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -5601,53 +5601,102 @@ def clip(self, lower=None, upper=None, axis=None, inplace=False, """ Trim values at input threshold(s). + E...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20212	2018-03-10T18:38:00Z	2018-03-15T15:23:59Z	null	2018-03-15T15:23:59Z
DOC: update the pd.Index.contains docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 888507a529687..85fbde799dae7 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1832,15 +1832,31 @@ def __contains__(self, key): return False _index_shared_docs['contains'] = """ - return ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20211	2018-03-10T18:29:20Z	2018-10-12T19:16:46Z	null	2018-11-20T15:18:32Z
DOC: update the Index.get_level_values docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index d7dda62ff2ac1..904aa3d4bcb03 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -3090,26 +3090,41 @@ def set_value(self, arr, key, value): def _get_level_values(self, level): """ - Return an In...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20210	2018-03-10T18:09:28Z	2018-07-08T15:07:18Z	2018-07-08T15:07:18Z	2018-07-08T15:07:18Z
DOC: update the DataFrame.eval() docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index ff3f377e07f98..c62ad1cbee5d7 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -2490,20 +2490,23 @@ def query(self, expr, inplace=False, kwargs): return new_data def eval(self, expr, inplace=False, kwargs): - """...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20209	2018-03-10T18:03:37Z	2018-03-13T14:27:33Z	2018-03-13T14:27:33Z	2018-03-13T14:27:33Z
DOC: update the pandas.errors.DtypeWarning docstring	diff --git a/pandas/errors/__init__.py b/pandas/errors/__init__.py index af4e83f506257..16654f0227182 100644 --- a/pandas/errors/__init__.py +++ b/pandas/errors/__init__.py @@ -38,9 +38,60 @@ class ParserError(ValueError): class DtypeWarning(Warning): """ - Warning that is raised for a dtype incompatibility....	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20208	2018-03-10T17:46:35Z	2018-03-13T14:55:29Z	2018-03-13T14:55:29Z	2018-03-13T16:24:48Z
DOC: update the pandas.api.types.is_list_like	diff --git a/pandas/core/dtypes/inference.py b/pandas/core/dtypes/inference.py index 6fed25a0012f2..0c51aaf1d3dd1 100644 --- a/pandas/core/dtypes/inference.py +++ b/pandas/core/dtypes/inference.py @@ -28,20 +28,33 @@ def is_number(obj): """ Check if the object is a number. + Booleans are valid because th...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20207	2018-03-10T17:27:12Z	2018-03-11T15:24:56Z	null	2018-03-11T15:25:13Z
DOC: update the DataFrame.head() docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 9f2112729a503..435915ef4d174 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -3605,7 +3605,11 @@ def f(x): def head(self, n=5): """ - Return the first n rows. + Return the first `n` rows. + + This...	- Improved summary details - Added description of last in see-also Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-func...	https://api.github.com/repos/pandas-dev/pandas/pulls/20206	2018-03-10T17:24:18Z	2018-03-10T19:48:13Z	2018-03-10T19:48:13Z	2018-03-11T15:29:29Z
DOC: update the docstring of pandas.DataFrame.from_dict	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..0d3c0aa4136ac 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -883,27 +883,53 @@ def dot(self, other): @classmethod def from_dict(cls, data, orient='columns', dtype=None, columns=None): """ - Construc...	``` ################################################################################ #################### Docstring (pandas.DataFrame.from_dict) #################### ################################################################################ Construct DataFrame from dict of array-like or dicts. Creates Da...	https://api.github.com/repos/pandas-dev/pandas/pulls/20205	2018-03-10T17:20:20Z	2018-03-10T20:47:08Z	null	2018-03-11T15:26:51Z
DOC: update the pandas.Series.dropna and pandas.DataFrame.dropna docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..102a788c78e56 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -3501,71 +3501,101 @@ def notnull(self): def dropna(self, axis=0, how='any', thresh=None, subset=None, inplace=False): """ - Re...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20204	2018-03-10T17:13:21Z	2018-03-16T21:01:44Z	2018-03-16T21:01:44Z	2018-03-18T18:09:58Z
DOC: update the CategoricalIndex docstring	diff --git a/pandas/core/indexes/category.py b/pandas/core/indexes/category.py index 71d39ad812d20..a1f2301a58f92 100644 --- a/pandas/core/indexes/category.py +++ b/pandas/core/indexes/category.py @@ -32,27 +32,65 @@ class CategoricalIndex(Index, accessor.PandasDelegate): """ + Immutable Index implementing a...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20203	2018-03-10T17:11:00Z	2018-11-01T01:35:41Z	null	2018-11-01T01:35:41Z
DOC: update the pandas.DataFrame.apply docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..249703bedcc21 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -4818,54 +4818,68 @@ def aggregate(self, func, axis=0, args, *kwargs): def apply(self, func, axis=0, broadcast=None, raw=False, reduce=None, ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20202	2018-03-10T17:05:41Z	2018-03-12T16:47:53Z	2018-03-12T16:47:52Z	2018-03-13T13:39:46Z
DOC: update the DataFrame.update() docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 79265e35ef6e6..8af56e5e1070d 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -4321,21 +4321,44 @@ def combiner(x, y, needs_i8_conversion=False): def update(self, other, join='left', overwrite=True, filter_func=None, rais...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20201	2018-03-10T17:03:52Z	2018-03-13T21:41:40Z	2018-03-13T21:41:40Z	2018-03-14T08:04:36Z
DOC: update the NDFrame.transform docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 2adc289f98d94..063c2e2038a75 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -4246,53 +4246,6 @@ def pipe(self, func, args, *kwargs): `agg` is an alias for `aggregate`. Use the alias. """) - _shared_docs['transform']...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20200	2018-03-10T16:51:04Z	2018-10-04T06:20:54Z	null	2018-10-04T06:21:11Z
DOC: update the pandas.Series.str.rpartition() docstring (Delhi)	diff --git a/pandas/core/strings.py b/pandas/core/strings.py index 669b19fc35430..ecc8c266b136d 100644 --- a/pandas/core/strings.py +++ b/pandas/core/strings.py @@ -2340,47 +2340,82 @@ def rsplit(self, pat=None, n=-1, expand=False): return self._wrap_result(result, expand=expand) _shared_docs['str_parti...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20199	2018-03-10T16:49:59Z	2018-07-08T17:24:15Z	2018-07-08T17:24:15Z	2018-07-08T17:24:58Z
Docstring changes to pandas.Series.dt.to_pydatetime	diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index c5b300848876e..c27754d57d82b 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -126,6 +126,49 @@ class DatetimeProperties(Properties): """ def to_pydatetime(self): + """ + ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20198	2018-03-10T16:42:38Z	2018-03-13T10:52:48Z	2018-03-13T10:52:48Z	2018-03-13T19:22:31Z
DOC: update the docstring of pandas.DataFrame.info	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..22e972850bbbf 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -1813,33 +1813,132 @@ def to_html(self, buf=None, columns=None, col_space=None, header=True, def info(self, verbose=None, buf=None, max_cols=None, memory_usage...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20197	2018-03-10T16:38:08Z	2018-03-17T10:05:53Z	2018-03-17T10:05:53Z	2018-03-17T10:05:54Z
DOC: update the api.types.is_number docstring	diff --git a/pandas/core/dtypes/inference.py b/pandas/core/dtypes/inference.py index 6fed25a0012f2..a02f0c5b2a4d6 100644 --- a/pandas/core/dtypes/inference.py +++ b/pandas/core/dtypes/inference.py @@ -28,20 +28,37 @@ def is_number(obj): """ Check if the object is a number. + Returns True when the object ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20196	2018-03-10T16:27:00Z	2018-03-17T12:24:05Z	2018-03-17T12:24:05Z	2018-03-17T12:24:11Z
DOC: Update the DataFrame.join() docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index d430d442fae0f..0d5cf971d3726 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -5334,22 +5334,21 @@ def append(self, other, ignore_index=False, verify_integrity=False): def join(self, other, on=None, how='left', lsuffix='', rsuffix='', ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20195	2018-03-10T16:16:29Z	2018-11-03T05:40:07Z	null	2018-11-03T05:40:08Z
DOC: Update the pandas.DataFrame.abs docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a893b2ba1a189..b9d97eec9a99c 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7115,12 +7115,70 @@ def _tz_localize(ax, tz, ambiguous): # Numeric Methods def abs(self): """ - Return an object with absolute va...	Improve description and returns, and added notes and examples. Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-...	https://api.github.com/repos/pandas-dev/pandas/pulls/20194	2018-03-10T16:09:27Z	2018-03-13T21:00:00Z	2018-03-13T21:00:00Z	2018-03-13T21:00:00Z
DOC: update the pandas.DataFrame.to_sparse docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 1c8b1ccd0fe8d..64edb8c3848d0 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -1599,16 +1599,57 @@ def from_csv(cls, path, header=0, sep=',', index_col=0, parse_dates=True, def to_sparse(self, fill_value=None, kind='block'): "...	Updates the docstring for the to_sparse function. Here is the output of the validation script: ``` ################################################################################ #################### Docstring (pandas.DataFrame.to_sparse) #################### ##################################################...	https://api.github.com/repos/pandas-dev/pandas/pulls/20193	2018-03-10T16:05:40Z	2018-07-10T13:06:02Z	2018-07-10T13:06:02Z	2018-07-10T13:06:32Z
DOC: update the Index.shift docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 52283e4e223b4..3c357788c9d6b 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -2256,18 +2256,19 @@ def sortlevel(self, level=None, ascending=True, sort_remaining=None): return self.sort_values(return_index...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20192	2018-03-10T16:04:36Z	2018-03-10T19:15:48Z	2018-03-10T19:15:48Z	2018-03-10T19:15:51Z
DOC: update DataFrame.to_records	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..7b112c5be6e8d 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -1209,20 +1209,68 @@ def from_records(cls, data, index=None, exclude=None, columns=None, def to_records(self, index=True, convert_datetime64=True): ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20191	2018-03-10T16:03:50Z	2018-03-11T11:58:10Z	2018-03-11T11:58:10Z	2018-03-11T15:29:29Z
DOC: Edit doc contribution section. …	diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 61efc6a707d31..a0c6f1332f339 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -262,8 +262,9 @@ after updating. Contributing to the documentation ================================= -If you're not the developer ty...	References #19412 - Removes negative tone about non-developer in 'Contributing to docs' section	https://api.github.com/repos/pandas-dev/pandas/pulls/20190	2018-03-10T15:57:46Z	2018-03-10T16:28:55Z	2018-03-10T16:28:54Z	2018-03-10T16:29:33Z
DOC: update the Series.dt.strftime docstring	diff --git a/pandas/core/indexes/datetimelike.py b/pandas/core/indexes/datetimelike.py index e673bfe411cb4..5928c20714542 100644 --- a/pandas/core/indexes/datetimelike.py +++ b/pandas/core/indexes/datetimelike.py @@ -61,18 +61,26 @@ def strftime(self, date_format): return np.asarray(self.format(date_format=dat...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20189	2018-03-10T15:56:10Z	2018-03-10T17:21:30Z	null	2018-03-10T17:21:30Z
DOC: update the pandas.IntervalIndex docstring	diff --git a/pandas/core/indexes/interval.py b/pandas/core/indexes/interval.py index ccf2e5e3c4486..6ee9376c118b4 100644 --- a/pandas/core/indexes/interval.py +++ b/pandas/core/indexes/interval.py @@ -142,20 +142,24 @@ class IntervalIndex(IntervalMixin, Index): Parameters ---------- - data : array-like (...	Docstring assignated to the Buenos Aires, Argentina chapter. Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or...	https://api.github.com/repos/pandas-dev/pandas/pulls/20188	2018-03-10T15:54:03Z	2018-10-14T22:35:25Z	null	2018-10-14T22:35:25Z
DOC: Update the pandas.Series.dt.round/floor/ceil docstrings	diff --git a/pandas/core/indexes/datetimelike.py b/pandas/core/indexes/datetimelike.py index e673bfe411cb4..1c41488973978 100644 --- a/pandas/core/indexes/datetimelike.py +++ b/pandas/core/indexes/datetimelike.py @@ -82,21 +82,84 @@ class TimelikeOps(object): _round_doc = ( """ - %s the index to ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20187	2018-03-10T15:53:32Z	2018-03-11T20:48:09Z	2018-03-11T20:48:09Z	2018-03-17T11:10:15Z
DOC: update the DataFrame.to_hdf() docstirng	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a893b2ba1a189..efe0b22f3b046 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -1786,40 +1786,50 @@ def to_json(self, path_or_buf=None, orient=None, date_format=None, index=index) def to_hdf(self, pa...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20186	2018-03-10T15:53:24Z	2018-03-22T09:23:27Z	2018-03-22T09:23:27Z	2018-03-22T09:23:40Z
DOC: update the to_excel docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 38f334762fa88..fa4572dd7b979 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -1836,65 +1836,98 @@ def _repr_latex_(self): # I/O Methods _shared_docs['to_excel'] = """ - Write %(klass)s to an excel sheet - %(versiona...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [ x] PR title is "DOC: update the <your-function-or-method> docstring" - [x ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x ] The PEP8 style check passes: `git diff upstr...	https://api.github.com/repos/pandas-dev/pandas/pulls/20185	2018-03-10T15:52:45Z	2018-07-24T16:02:34Z	2018-07-24T16:02:34Z	2018-07-25T04:49:38Z
DOC: update the pandas.Series.dt.is_leap_year docstring	diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index 491fefe8efee0..1ff5eb2481b13 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1753,7 +1753,32 @@ def freq(self, value): is_leap_year = _field_accessor( 'is_leap_year', 'i...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [O] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20184	2018-03-10T15:48:07Z	2018-03-17T12:15:47Z	null	2018-03-17T12:15:47Z
DOC: Update the DatetimeIndex.floor docstring	diff --git a/pandas/core/indexes/datetimelike.py b/pandas/core/indexes/datetimelike.py index e673bfe411cb4..1fe5330a12325 100644 --- a/pandas/core/indexes/datetimelike.py +++ b/pandas/core/indexes/datetimelike.py @@ -97,6 +97,7 @@ class TimelikeOps(object): ValueError if the freq cannot be converted "...	Signed-off-by: Tushar Mittal <chiragmittal.mittal@gmail.com> Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or...	https://api.github.com/repos/pandas-dev/pandas/pulls/20182	2018-03-10T15:42:54Z	2018-07-08T22:07:38Z	null	2023-05-11T01:17:33Z
DOC: update the pandas.Series.dt.is_month_end docstring	diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index ac7db1dbc4b8f..e8bc9a2519333 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -1773,7 +1773,41 @@ def freq(self, value): is_month_end = _field_accessor( 'is_month_end', 'i...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20181	2018-03-10T15:41:57Z	2018-03-17T11:59:09Z	2018-03-17T11:59:09Z	2018-03-17T11:59:27Z
DOC: update the pandas.Index.notna docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 52283e4e223b4..cbf0f7a70ff2f 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -2040,18 +2040,47 @@ def isna(self): def notna(self): """ - Inverse of isna + Detect existing (non-missing...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20180	2018-03-10T15:38:21Z	2018-03-12T22:13:07Z	2018-03-12T22:13:07Z	2018-03-14T10:55:20Z
DOC: Improve the docstring of Series.take	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a893b2ba1a189..e026757a52205 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -2521,28 +2521,43 @@ def _take(self, indices, axis=0, convert=True, is_copy=True): ---------- indices : array-like An array o...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20179	2018-03-10T15:32:03Z	2018-03-14T20:17:23Z	2018-03-14T20:17:23Z	2018-03-14T21:27:37Z
DOC: Improved the docstring of pandas.Series.clip	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a893b2ba1a189..4f7c3f71f5322 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -5548,53 +5548,75 @@ def clip(self, lower=None, upper=None, axis=None, inplace=False, """ Trim values at input threshold(s). + As...	``` ################################################################################ ######################## Docstring (pandas.Series.clip) ######################## ################################################################################ Trim values at input threshold(s). Truncates values below an...	https://api.github.com/repos/pandas-dev/pandas/pulls/20178	2018-03-10T15:30:21Z	2018-03-10T21:22:34Z	null	2018-03-11T10:50:10Z
DOC: Improved the docstring of pandas.Series.dt.components	diff --git a/pandas/core/indexes/accessors.py b/pandas/core/indexes/accessors.py index 08d4de972bc06..d7b4ea63cd48c 100644 --- a/pandas/core/indexes/accessors.py +++ b/pandas/core/indexes/accessors.py @@ -237,14 +237,30 @@ def to_pytimedelta(self): @property def components(self): """ - Return ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [ ] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20177	2018-03-10T15:17:48Z	2018-07-08T15:26:56Z	2018-07-08T15:26:56Z	2018-07-08T15:27:09Z
DOC: update the pandas.Series.tail docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a893b2ba1a189..c355dcb2c4bfe 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -3669,12 +3669,12 @@ def tail(self, n=5): Returns ------- - obj_tail : type of caller - The last n rows of the caller ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20176	2018-03-10T15:16:32Z	2018-03-10T16:12:42Z	2018-03-10T16:12:42Z	2018-03-10T16:12:42Z
DOC: update the Series.isin docstring	diff --git a/pandas/core/series.py b/pandas/core/series.py index 069f0372ab6e1..72f375c155e99 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -2745,20 +2745,21 @@ def _take(self, indices, axis=0, convert=True, is_copy=False): def isin(self, values): """ - Return a boolean :class...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20175	2018-03-10T15:16:23Z	2018-03-10T16:25:21Z	2018-03-10T16:25:21Z	2018-03-10T16:30:08Z
DOC: update the Seriex.idxmax and Series.idxmin docstring	diff --git a/pandas/core/series.py b/pandas/core/series.py index 069f0372ab6e1..3c045760ba56b 100644 --- a/pandas/core/series.py +++ b/pandas/core/series.py @@ -1326,22 +1326,31 @@ def duplicated(self, keep='first'): def idxmin(self, axis=None, skipna=True, args, kwargs): """ - Index label* o...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20174	2018-03-10T15:16:16Z	2018-03-12T17:30:49Z	2018-03-12T17:30:49Z	2018-03-12T17:45:14Z
DOC: update the pandas.DataFrame.to_string docstring	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 1c8b1ccd0fe8d..18874d290c170 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -1966,7 +1966,8 @@ def to_parquet(self, fname, engine='auto', compression='snappy', @Substitution(header='Write out the column names. If a list of strings ' ...	Had to correct parameters descriptions in common docstrings (format.py) as well as in frame.py. Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/valid...	https://api.github.com/repos/pandas-dev/pandas/pulls/20173	2018-03-10T15:14:12Z	2018-07-10T00:06:41Z	2018-07-10T00:06:41Z	2018-07-10T00:06:44Z
DOC: update the str_cat() docstring (Delhi)	diff --git a/pandas/core/strings.py b/pandas/core/strings.py index 6b427ed1da834..d6ea5d0e4bf0d 100644 --- a/pandas/core/strings.py +++ b/pandas/core/strings.py @@ -51,11 +51,18 @@ def str_cat(arr, others=None, sep=None, na_rep=None): """ Concatenate strings in the Series/Index with given separator. + If...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20171	2018-03-10T15:07:17Z	2018-03-14T14:37:29Z	2018-03-14T14:37:29Z	2018-03-14T14:37:48Z
DOC: update the pandas.DataFrame.plot.area docstring	diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index e81b162645b94..85b2738e572b6 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -3337,19 +3337,87 @@ def kde(self, bw_method=None, ind=None, kwds): def area(self, x=None, y=None, kwds): """ - Area plot...	- [x] PR title is "DOC: update the pandas.DataFrame.plot.area docstring" - [x] The validation script passes: `scripts/validate_docstrings.py pandas.DataFrame.plot.area` - [x] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" \| flake8 --diff` - [x] The html version looks good: `python doc/make.py --...	https://api.github.com/repos/pandas-dev/pandas/pulls/20170	2018-03-10T15:04:41Z	2018-08-10T17:07:44Z	2018-08-10T17:07:44Z	2018-08-13T09:58:34Z
DOC: Improved the docstring of pandas.plotting.radviz	diff --git a/pandas/plotting/_misc.py b/pandas/plotting/_misc.py index 45594e9c6ea95..03a06169d46bc 100644 --- a/pandas/plotting/_misc.py +++ b/pandas/plotting/_misc.py @@ -147,25 +147,66 @@ def _get_marker_compat(marker): def radviz(frame, class_column, ax=None, color=None, colormap=None, **kwds): - """RadViz ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20169	2018-03-10T15:00:04Z	2018-03-11T11:56:49Z	2018-03-11T11:56:49Z	2018-03-11T15:29:29Z
DOC: Docstring pandas index all any	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index 888507a529687..f4066095ebd1e 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -4290,20 +4290,86 @@ def _add_logical_methods(cls): """ add in logical methods """ _doc = """ - %(desc)s ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20168	2018-03-10T14:59:22Z	2018-03-13T20:56:10Z	2018-03-13T20:56:10Z	2018-03-13T20:56:12Z
DOC: update the pandas.Index.is_categorical docstring	diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index e82b641db98fd..45b6b08dc41f2 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -1195,7 +1195,7 @@ def to_frame(self, index=True): -------- >>> idx = pd.Index(['Ant', 'Bear', 'Cow'], name='animal') ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [ ] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20167	2018-03-10T14:55:50Z	2018-03-12T14:32:09Z	2018-03-12T14:32:09Z	2018-03-12T14:32:12Z
Docstring bootstrap plot	diff --git a/pandas/plotting/_misc.py b/pandas/plotting/_misc.py index 45594e9c6ea95..507bdb755e1d7 100644 --- a/pandas/plotting/_misc.py +++ b/pandas/plotting/_misc.py @@ -323,20 +323,51 @@ def f(t): def bootstrap_plot(series, fig=None, size=50, samples=500, **kwds): - """Bootstrap plot. + """ + Bootstra...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20166	2018-03-10T14:53:21Z	2018-03-11T17:57:38Z	2018-03-11T17:57:38Z	2018-03-17T11:11:26Z
DOC: update the pandas.Series.where docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 48366a286ac05..8da678e0adec0 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -7778,9 +7778,7 @@ def _where(self, cond, other=np.nan, inplace=False, axis=None, level=None, return self._constructor(new_data).__finalize__(s...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20165	2018-03-10T14:53:04Z	2018-07-08T16:03:38Z	2018-07-08T16:03:38Z	2018-07-08T16:03:44Z
DOC: update the pandas.Series.set_axis docstring	diff --git a/pandas/core/generic.py b/pandas/core/generic.py index a893b2ba1a189..fae9f013d9eba 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -487,24 +487,37 @@ def _expand_axes(self, key): return new_axes - _shared_docs['set_axis'] = """Assign desired index to given axis + def ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [x] PR title is "DOC: update the <your-function-or-method> docstring" - [x] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [x] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20164	2018-03-10T14:49:55Z	2018-03-16T11:40:26Z	2018-03-16T11:40:26Z	2018-03-17T10:35:10Z
DOC: update the DataFrame.plot.line docstring	diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py index c22741479a837..2c2521ad50ce0 100644 --- a/pandas/plotting/_core.py +++ b/pandas/plotting/_core.py @@ -2772,19 +2772,64 @@ def __call__(self, x=None, y=None, kind='line', ax=None, def line(self, x=None, y=None, **kwds): """ - L...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20163	2018-03-10T14:49:48Z	2018-03-12T12:02:40Z	2018-03-12T12:02:40Z	2018-03-12T12:02:44Z
DOC: update the docstring of pandas.DataFrame.to_dict	diff --git a/pandas/core/frame.py b/pandas/core/frame.py index a66d00fff9714..f75855934d194 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -924,21 +924,25 @@ def from_dict(cls, data, orient='columns', dtype=None, columns=None): return cls(data, index=index, columns=columns, dtype=dtype) ...	Checklist for the pandas documentation sprint (ignore this if you are doing an unrelated PR): - [X] PR title is "DOC: update the <your-function-or-method> docstring" - [X] The validation script passes: `scripts/validate_docstrings.py <your-function-or-method>` - [X] The PEP8 style check passes: `git diff upstream...	https://api.github.com/repos/pandas-dev/pandas/pulls/20162	2018-03-10T14:43:57Z	2018-03-13T19:22:09Z	2018-03-13T19:22:09Z	2018-03-13T19:22:09Z

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.