Skip to content

DOC: fix doc build warnings #15505

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 1 commit into from
Feb 25, 2017
Merged
Show file tree
Hide file tree
Changes from all 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/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -965,6 +965,7 @@ The different indexing operation can potentially change the dtype of a ``Series`
res

.. ipython:: python

series2 = pd.Series([True])
series2.dtype
res = series2.reindex_like(series1)
Expand Down
2 changes: 1 addition & 1 deletion doc/source/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1889,7 +1889,7 @@ gotchas

Performing selection operations on ``integer`` type data can easily upcast the data to ``floating``.
The dtype of the input data will be preserved in cases where ``nans`` are not introduced (starting in 0.11.0)
See also :ref:`Support for integer ``NA`` <gotchas.intna>`
See also :ref:`Support for integer NA <gotchas.intna>`

.. ipython:: python
Expand Down
6 changes: 3 additions & 3 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -461,7 +461,7 @@ C (cpplint)

*pandas* uses the `Google <https://google.github.io/styleguide/cppguide.html>`_
standard. Google provides an open source style checker called ``cpplint``, but we
use a fork of it that can be found `here <https://github.com/cpplint/cpplint>`_.
use a fork of it that can be found `here <https://github.com/cpplint/cpplint>`__.
Here are *some* of the more common ``cpplint`` issues:

- we restrict line-length to 80 characters to promote readability
Expand All @@ -479,7 +479,7 @@ You can also run this command on an entire directory if necessary::

To make your commits compliant with this standard, you can install the
`ClangFormat <http://clang.llvm.org/docs/ClangFormat.html>`_ tool, which can be
downloaded `here <http://llvm.org/builds/>`_. To configure, in your home directory,
downloaded `here <http://llvm.org/builds/>`__. To configure, in your home directory,
run the following command::

clang-format style=google -dump-config > .clang-format
Expand Down Expand Up @@ -611,7 +611,7 @@ Or with one of the following constructs::
pytest pandas/tests/[test-module].py::[TestClass]
pytest pandas/tests/[test-module].py::[TestClass]::[test_method]

For more, see the `pytest<http://doc.pytest.org/en/latest/>`_ documentation.
For more, see the `pytest <http://doc.pytest.org/en/latest/>`_ documentation.

.. versionadded:: 0.20.0

Expand Down
2 changes: 1 addition & 1 deletion doc/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ Optional Dependencies
okay.)
* `BeautifulSoup4`_ and `lxml`_
* `BeautifulSoup4`_ and `html5lib`_ and `lxml`_
* Only `lxml`_, although see :ref:`HTML Table Parsing <gotchas.html>`
* Only `lxml`_, although see :ref:`HTML Table Parsing <io.html.gotchas>`
for reasons as to why you should probably **not** take this approach.

.. warning::
Expand Down
8 changes: 4 additions & 4 deletions doc/source/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2043,7 +2043,7 @@ Reading HTML Content

.. warning::

We **highly encourage** you to read the :ref:`HTML Table Parsing gotchas<io.html.gotchas>`
We **highly encourage** you to read the :ref:`HTML Table Parsing gotchas <io.html.gotchas>`
below regarding the issues surrounding the BeautifulSoup4/html5lib/lxml parsers.

.. versionadded:: 0.12.0
Expand Down Expand Up @@ -4681,15 +4681,15 @@ The key functions are:


Supported Data Types
++++++++++++++++++++
''''''''''''''''''''

Pandas supports all these `BigQuery data types <https://cloud.google.com/bigquery/data-types>`__:
``STRING``, ``INTEGER`` (64bit), ``FLOAT`` (64 bit), ``BOOLEAN`` and
``TIMESTAMP`` (microsecond precision). Data types ``BYTES`` and ``RECORD``
are not supported.

Integer and boolean ``NA`` handling
+++++++++++++++++++++++++++++++++++
'''''''''''''''''''''''''''''''''''

.. versionadded:: 0.20

Expand All @@ -4710,7 +4710,7 @@ and unnoticed precision lost for identifier is what we want to avoid.
.. _io.bigquery_deps:

Dependencies
++++++++++++
''''''''''''

This module requires following additional dependencies:

Expand Down
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v0.20.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Notably, a new numerical index, ``UInt64Index``, has been created (:issue:`14937
- Bug in ``pd.unique()`` in which unsigned 64-bit integers were causing overflow (:issue:`14915`)
- Bug in ``pd.value_counts()`` in which unsigned 64-bit integers were being erroneously truncated in the output (:issue:`14934`)

.. _whatsnew_0200.enhancements.groupy_categorical
.. _whatsnew_0200.enhancements.groupy_categorical:

GroupBy on Categoricals
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
1 change: 1 addition & 0 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -1035,6 +1035,7 @@ def __setstate__(self, state):
_shared_docs['to_excel'] = """
Write %(klass)s to an excel sheet
%(versionadded_to_excel)s

Parameters
----------
excel_writer : string or ExcelWriter object
Expand Down
2 changes: 1 addition & 1 deletion pandas/io/html.py
Original file line number Diff line number Diff line change
Expand Up @@ -853,7 +853,7 @@ def read_html(io, match='.+', flavor=None, header=None, index_col=None,
Notes
-----
Before using this function you should read the :ref:`gotchas about the
HTML parsing libraries <html-gotchas>`.
HTML parsing libraries <io.html.gotchas>`.

Expect to do some cleanup after you call this function. For example, you
might need to manually assign column names if the column names are
Expand Down
9 changes: 4 additions & 5 deletions pandas/io/json/normalize.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,10 @@ def json_normalize(data, record_path=None, meta=None,
path to records is ['foo', 'bar']
meta_prefix : string, default None
errors : {'raise', 'ignore'}, default 'raise'

* ignore : will ignore KeyError if keys listed in meta are not
always present
* raise : will raise KeyError if keys listed in meta are not
always present
* 'ignore' : will ignore KeyError if keys listed in meta are not
always present
* 'raise' : will raise KeyError if keys listed in meta are not
always present

.. versionadded:: 0.20.0

Expand Down
10 changes: 5 additions & 5 deletions pandas/io/parsers.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@
If True and parse_dates is enabled, pandas will attempt to infer the format
of the datetime strings in the columns, and if it can be inferred, switch
to a faster method of parsing them. In some cases this can increase the
parsing speed by ~5-10x.
parsing speed by 5-10x.
keep_date_col : boolean, default False
If True and parse_dates specifies combining multiple columns then
keep the original columns.
Expand All @@ -200,10 +200,10 @@
Return TextFileReader object for iteration or getting chunks with
``get_chunk()``.
chunksize : int, default None
Return TextFileReader object for iteration. `See IO Tools docs for more
information
<http://pandas.pydata.org/pandas-docs/stable/io.html#io-chunking>`_ on
``iterator`` and ``chunksize``.
Return TextFileReader object for iteration.
See the `IO Tools docs
<http://pandas.pydata.org/pandas-docs/stable/io.html#io-chunking>`_
for more information on ``iterator`` and ``chunksize``.
compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None}, default 'infer'
For on-the-fly decompression of on-disk data. If 'infer', then use gzip,
bz2, zip or xz if filepath_or_buffer is a string ending in '.gz', '.bz2',
Expand Down