Skip to content

DOC: some doc fixes #17913

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.

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 4 commits into from
Oct 19, 2017
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,7 @@ The dtype of a ``Categorical`` can be described by a :class:`pandas.api.types.Ca

.. autosummary::
:toctree: generated/
:template: autosummary/class_without_autosummary.rst
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this fix all those extra warnings I introduced?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, I see the extension of the hack below :) thanks.


api.types.CategoricalDtype

Expand Down
2 changes: 1 addition & 1 deletion doc/source/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1205,7 +1205,7 @@ You may also use ``reindex`` with an ``axis`` keyword:

.. ipython:: python

df.reindex(index=['c', 'f', 'b'], axis='index')
df.reindex(['c', 'f', 'b'], axis='index')

Note that the ``Index`` objects containing the actual axis labels can be
**shared** between objects. So if we have a Series and a DataFrame, the
Expand Down
12 changes: 0 additions & 12 deletions doc/source/indexing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1509,18 +1509,6 @@ default value.
s.get('a') # equivalent to s['a']
s.get('x', default=-1)

The :meth:`~pandas.DataFrame.select` Method
-------------------------------------------

Another way to extract slices from an object is with the ``select`` method of
Series, DataFrame, and Panel. This method should be used only when there is no
more direct way. ``select`` takes a function which operates on labels along
``axis`` and returns a boolean. For instance:

.. ipython:: python

df.select(lambda x: x == 'A', axis=1)

The :meth:`~pandas.DataFrame.lookup` Method
-------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion doc/source/missing_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ With ``sum`` or ``prod`` on an empty or all-``NaN`` ``Series``, or columns of a

.. ipython:: python

s = Series([np.nan])
s = pd.Series([np.nan])

s.sum()

Expand Down
2 changes: 1 addition & 1 deletion doc/sphinxext/numpydoc/numpydoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def mangle_docstrings(app, what, name, obj, options, lines,
# PANDAS HACK (to remove the list of methods/attributes for Categorical)
no_autosummary = [".Categorical", "CategoricalIndex", "IntervalIndex",
"RangeIndex", "Int64Index", "UInt64Index",
"Float64Index", "PeriodIndex"]
"Float64Index", "PeriodIndex", "CategoricalDtype"]
if what == "class" and any(name.endswith(n) for n in no_autosummary):
cfg['class_members_list'] = False

Expand Down
88 changes: 45 additions & 43 deletions pandas/_libs/period.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -833,9 +833,9 @@ cdef class _Period(object):

Parameters
----------
freq : string or DateOffset, default is 'D' if self.freq is week or
longer and 'S' otherwise
Target frequency
freq : string or DateOffset
Target frequency. Default is 'D' if self.freq is week or
longer and 'S' otherwise
how: str, default 'S' (start)
'S', 'E'. Can be aliased as case insensitive
'Start', 'Finish', 'Begin', 'End'
Expand Down Expand Up @@ -1067,46 +1067,48 @@ cdef class _Period(object):
| ``%%`` | A literal ``'%'`` character. | |
+-----------+--------------------------------+-------+

.. note::

(1)
The ``%f`` directive is the same as ``%y`` if the frequency is
not quarterly.
Otherwise, it corresponds to the 'fiscal' year, as defined by
the :attr:`qyear` attribute.

(2)
The ``%F`` directive is the same as ``%Y`` if the frequency is
not quarterly.
Otherwise, it corresponds to the 'fiscal' year, as defined by
the :attr:`qyear` attribute.

(3)
The ``%p`` directive only affects the output hour field
if the ``%I`` directive is used to parse the hour.

(4)
The range really is ``0`` to ``61``; this accounts for leap
seconds and the (very rare) double leap seconds.

(5)
The ``%U`` and ``%W`` directives are only used in calculations
when the day of the week and the year are specified.

.. rubric:: Examples

>>> a = Period(freq='Q@JUL', year=2006, quarter=1)
>>> a.strftime('%F-Q%q')
'2006-Q1'
>>> # Output the last month in the quarter of this date
>>> a.strftime('%b-%Y')
'Oct-2005'
>>>
>>> a = Period(freq='D', year=2001, month=1, day=1)
>>> a.strftime('%d-%b-%Y')
'01-Jan-2006'
>>> a.strftime('%b. %d, %Y was a %A')
'Jan. 01, 2001 was a Monday'
Notes
-----

(1)
The ``%f`` directive is the same as ``%y`` if the frequency is
not quarterly.
Otherwise, it corresponds to the 'fiscal' year, as defined by
the :attr:`qyear` attribute.

(2)
The ``%F`` directive is the same as ``%Y`` if the frequency is
not quarterly.
Otherwise, it corresponds to the 'fiscal' year, as defined by
the :attr:`qyear` attribute.

(3)
The ``%p`` directive only affects the output hour field
if the ``%I`` directive is used to parse the hour.

(4)
The range really is ``0`` to ``61``; this accounts for leap
seconds and the (very rare) double leap seconds.

(5)
The ``%U`` and ``%W`` directives are only used in calculations
when the day of the week and the year are specified.

Examples
--------

>>> a = Period(freq='Q@JUL', year=2006, quarter=1)
>>> a.strftime('%F-Q%q')
'2006-Q1'
>>> # Output the last month in the quarter of this date
>>> a.strftime('%b-%Y')
'Oct-2005'
>>>
>>> a = Period(freq='D', year=2001, month=1, day=1)
>>> a.strftime('%d-%b-%Y')
'01-Jan-2006'
>>> a.strftime('%b. %d, %Y was a %A')
'Jan. 01, 2001 was a Monday'
"""
base, mult = get_freq_code(self.freq)
return period_format(self.ordinal, base, fmt)
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -2634,7 +2634,7 @@ def assign(self, **kwargs):
Notes
-----
For python 3.6 and above, the columns are inserted in the order of
**kwargs. For python 3.5 and earlier, since **kwargs is unordered,
\*\*kwargs. For python 3.5 and earlier, since \*\*kwargs is unordered,
the columns are inserted in alphabetical order at the end of your
DataFrame. Assigning multiple columns within the same ``assign``
is possible, but you cannot reference other columns created within
Expand Down
8 changes: 4 additions & 4 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -846,8 +846,8 @@ def _validate_axis_style_args(self, arg, arg_name, axes,

``DataFrame.rename`` supports two calling conventions

* ``(index=index_mapper, columns=columns_mapper, ...)
* ``(mapper, axis={'index', 'columns'}, ...)
* ``(index=index_mapper, columns=columns_mapper, ...)``
* ``(mapper, axis={'index', 'columns'}, ...)``

We *highly* recommend using keyword arguments to clarify your
intent.
Expand Down Expand Up @@ -2875,8 +2875,8 @@ def sort_index(self, axis=0, level=None, ascending=True, inplace=False,

``DataFrame.reindex`` supports two calling conventions

* ``(index=index_labels, columns=column_labels, ...)
* ``(labels, axis={'index', 'columns'}, ...)
* ``(index=index_labels, columns=column_labels, ...)``
* ``(labels, axis={'index', 'columns'}, ...)``

We *highly* recommend using keyword arguments to clarify your
intent.
Expand Down