Skip to content

Rt05 documentation error fix issue 25108 #25309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 30 commits into from
Feb 14, 2019
Merged

Rt05 documentation error fix issue 25108 #25309

Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
777fe4c
pandas.plotting.bootstrap_plot doc updated
zangell44 Feb 12, 2019
a595cac
generic aggregate docstring updated
zangell44 Feb 12, 2019
507d21e
generic clip method docstring updated
zangell44 Feb 12, 2019
950f272
pandas.series.unique docstring update
zangell44 Feb 12, 2019
ba5120f
generic align docstring updated
zangell44 Feb 12, 2019
3cd359f
generic interpolate docstring updated
zangell44 Feb 12, 2019
0266006
generic asof docstric update
zangell44 Feb 12, 2019
86456dd
pandas.tseries.frequencies.to_offset return docstring fix
zangell44 Feb 12, 2019
a86736b
pandas.Index.reindex return docstring fix
zangell44 Feb 12, 2019
7d57782
indexes/base.py return docstring updates
zangell44 Feb 13, 2019
b47b886
indexes/multi.py return docstring updates
zangell44 Feb 13, 2019
63f0468
DataFrame.get_ftype_counts and DataFrame.get_values return docstring …
zangell44 Feb 13, 2019
8d4c6b4
pandas plotting area and boxplot method return docstring updates
zangell44 Feb 13, 2019
a15ec00
pandas.Panel set_value major_xs minor_xs methods return docstring upd…
zangell44 Feb 13, 2019
01a7b19
pandas.Categorical.array return docstring update
zangell44 Feb 13, 2019
998f649
pandas.unique return docstring update
zangell44 Feb 13, 2019
77bd88e
pandas.wide_to_long return docstring update
zangell44 Feb 13, 2019
b090af1
pandas.to_numeric return docstring update
zangell44 Feb 13, 2019
20adfce
pandas.core.window kurt return docstring updated
zangell44 Feb 13, 2019
0514c6f
pandas.io.formats.style.Styler.render return docstring fix
zangell44 Feb 13, 2019
0038a73
strftime return statement docstring fix
zangell44 Feb 13, 2019
021ede4
series.set_value return statement docstring fix
zangell44 Feb 13, 2019
f3a5248
DataFrame.set_value return statement docstring fix
zangell44 Feb 13, 2019
421bab7
pandas.core.Series.unique return docstring update, moved extended des…
zangell44 Feb 14, 2019
24b20a3
pandas.plotting._core.box_plot return docstring udpated, extended ret…
zangell44 Feb 14, 2019
ae87624
code_checks.sh script updated to include RT05 errors in docstring
zangell44 Feb 14, 2019
8b3d251
updated code check CI script to actually check for RT05 errors this t…
zangell44 Feb 14, 2019
6b3ed7b
pandas.plotting._core.box_plot docstring minor formatting edits
zangell44 Feb 14, 2019
dd242ea
pandas.core.Series.unique trailing period removed from Notes portion …
zangell44 Feb 14, 2019
83e120f
Merge remote-tracking branch 'upstream/master' into RT05_documentatio…
zangell44 Feb 14, 2019
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
pandas.core.Series.unique return docstring update, moved extended des… 
…cription to Notes
  • Loading branch information
@zangell44
zangell44 committed Feb 14, 2019
commit 421bab7d0e751069b735c0db41b7ce7060e6cd4e
22 changes: 13 additions & 9 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1648,10 +1648,19 @@ def unique(self):
Returns
-------
ndarray or ExtensionArray
The unique values returned as a NumPy array. In case of an
extension-array backed Series, a new
:class:`~api.extensions.ExtensionArray` of that type with just
the unique values is returned. This includes
The unique values returned as a NumPy array. See Notes.

See Also
--------
unique : Top-level unique method for any 1-d array-like object.
Index.unique : Return Index with unique values from an Index object.

Notes
-----
Returns the unique values as a NumPy array. In case of an
extension-array backed Series, a new
:class:`~api.extensions.ExtensionArray` of that type with just
the unique values is returned. This includes

* Categorical
* Period
Expand All @@ -1660,11 +1669,6 @@ def unique(self):
* Sparse
* IntegerNA.
Copy link
Member

@WillAyd WillAyd Feb 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this "works" but seems hacky and rather long for a return. Can you move some of this into a Notes section instead?
Copy link
Contributor Author

@zangell44 zangell44 Feb 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed, I put the basic return documentation in the Return section. Everything else moved to a new Notes section
Copy link
Member

@WillAyd WillAyd Feb 14, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but can remove trailing period now

See Also
--------
unique : Top-level unique method for any 1-d array-like object.
Index.unique : Return Index with unique values from an Index object.

Examples
--------
>>> pd.Series([2, 1, 3, 3], name='A').unique()
Expand Down