Skip to content

Commit 2522efa

Browse files
TomAugspurgerjorisvandenbossche
authored andcommitted
DOC: Various doc fixes (#16035)
- Fixed spacing - Fixed method reference - Fixed list line wrapping - Fixed unbalanced ticks - Fixed section-heading without colon - Changed Interval Properties -> Attributes - Changed Styler properties
1 parent 816f945 commit 2522efa

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

doc/source/whatsnew/v0.20.0.txt

+6-6
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ The following are now part of this API:
176176
``pandas.testing``
177177
^^^^^^^^^^^^^^^^^^
178178

179-
We are adding a standard module that exposes the public testing functions in ``pandas.testing``(:issue:`9895`). Those functions can be used when writing tests for functionality using pandas objects.
179+
We are adding a standard module that exposes the public testing functions in ``pandas.testing`` (:issue:`9895`). Those functions can be used when writing tests for functionality using pandas objects.
180180

181181
The following testing functions are now part of this API:
182182

@@ -517,7 +517,7 @@ Other Enhancements
517517
- ``pandas.io.json.json_normalize()`` gained the option ``errors='ignore'|'raise'``; the default is ``errors='raise'`` which is backward compatible. (:issue:`14583`)
518518
- ``pandas.io.json.json_normalize()`` with an empty ``list`` will return an empty ``DataFrame`` (:issue:`15534`)
519519
- ``pandas.io.json.json_normalize()`` has gained a ``sep`` option that accepts ``str`` to separate joined fields; the default is ".", which is backward compatible. (:issue:`14883`)
520-
- :method:`~MultiIndex.remove_unused_levels` has been added to facilitate :ref:`removing unused levels <advanced.shown_levels>`. (:issue:`15694`)
520+
- :meth:`~MultiIndex.remove_unused_levels` has been added to facilitate :ref:`removing unused levels <advanced.shown_levels>`. (:issue:`15694`)
521521
- ``pd.read_csv()`` will now raise a ``ParserError`` error whenever any parsing error occurs (:issue:`15913`, :issue:`15925`)
522522
- ``pd.read_csv()`` now supports the ``error_bad_lines`` and ``warn_bad_lines`` arguments for the Python parser (:issue:`15925`)
523523
- The ``display.show_dimensions`` option can now also be used to specify
@@ -620,8 +620,8 @@ However, ``.agg(..)`` can *also* accept a dict that allows 'renaming' of the res
620620
between ``Series`` and ``DataFrame``. We are deprecating this 'renaming' functionaility.
621621

622622
- We are deprecating passing a dict to a grouped/rolled/resampled ``Series``. This allowed
623-
one to ``rename`` the resulting aggregation, but this had a completely different
624-
meaning than passing a dictionary to a grouped ``DataFrame``, which accepts column-to-aggregations.
623+
one to ``rename`` the resulting aggregation, but this had a completely different
624+
meaning than passing a dictionary to a grouped ``DataFrame``, which accepts column-to-aggregations.
625625
- We are deprecating passing a dict-of-dicts to a grouped/rolled/resampled ``DataFrame`` in a similar manner.
626626

627627
This is an illustrative example:
@@ -1363,9 +1363,9 @@ If indicated, a deprecation warning will be issued if you reference theses modul
13631363
"pandas._testing", "pandas.util.libtesting", ""
13641364
"pandas._window", "pandas.core.libwindow", ""
13651365

1366-
- The function :func:`~pandas.api.type.union_categoricals` is now importable from ``pandas.api.types``, formerly from ``pandas.types.concat`` (:issue:`15998`)
1366+
- The function :func:`~pandas.api.types.union_categoricals` is now importable from ``pandas.api.types``, formerly from ``pandas.types.concat`` (:issue:`15998`)
13671367

1368-
.. _whatsnew_0200.privacy.deprecate_plotting
1368+
.. _whatsnew_0200.privacy.deprecate_plotting:
13691369

13701370
Deprecate .plotting
13711371
^^^^^^^^^^^^^^^^^^^

pandas/_libs/interval.pyx

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ cdef class Interval(IntervalMixin):
5252
5353
.. versionadded:: 0.20.0
5454
55-
Properties
55+
Attributes
5656
----------
5757
left, right : values
5858
Left and right bounds for each interval.

pandas/core/generic.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -4217,14 +4217,14 @@ def groupby(self, by=None, axis=0, level=None, as_index=True, sort=True,
42174217
42184218
Parameters
42194219
----------
4220-
by : mapping function / list of functions, dict, Series, ndarray,
4221-
or tuple / list of column names or index level names or
4222-
Series or ndarrays
4223-
Called on each element of the object index to determine the groups.
4224-
If a dict or Series is passed, the Series or dict VALUES will be
4225-
used to determine the groups (the Series' values are first
4226-
aligned; see ``.align()`` method). If ndarray is passed, the
4227-
values as-is determine the groups.
4220+
by : mapping, function, str, or iterable
4221+
Used to determine the groups for the groupby.
4222+
If ``by`` is a function, it's called on each value of the object's
4223+
index. If a dict or Series is passed, the Series or dict VALUES
4224+
will be used to determine the groups (the Series' values are first
4225+
aligned; see ``.align()`` method). If an ndarray is passed, the
4226+
values are used as-is determine the groups. A str or list of strs
4227+
may be passed to group by the columns in ``self``
42284228
axis : int, default 0
42294229
level : int, level name, or sequence of such, default None
42304230
If the axis is a MultiIndex (hierarchical), group by a particular

pandas/io/formats/style.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ class Styler(object):
7171
Attributes
7272
----------
7373
env : Jinja2 Environment
74-
template: Jinja2 Template
74+
template : Jinja2 Template
7575
loader : Jinja2 Loader
7676
7777
Notes

0 commit comments

Comments
 (0)