Skip to content

Commit 90bbe35

Browse files
DOC: fix some doc build errors
- wrap docstring -> raw indication needed for newlines characters - using anonymous hyperlinks (two underscores instead of one) for preventing warning on same names - some missing imports and whitespace
1 parent fc1449f commit 90bbe35

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

doc/source/basics.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ see :ref:`here<indexing.boolean>`
236236
Boolean Reductions
237237
~~~~~~~~~~~~~~~~~~
238238

239-
You can apply the reductions: :attr:`~DataFrame.empty`, :meth:`~DataFrame.any`,
239+
You can apply the reductions: :attr:`~DataFrame.empty`, :meth:`~DataFrame.any`,
240240
:meth:`~DataFrame.all`, and :meth:`~DataFrame.bool` to provide a
241241
way to summarize a boolean result.
242242

doc/source/contributing.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,10 @@ This creates the directory `pandas-yourname` and connects your repository to
113113
the upstream (main project) *pandas* repository.
114114

115115
The testing suite will run automatically on Travis-CI once your Pull Request is
116-
submitted. However, if you wish to run the test suite on a branch prior to
116+
submitted. However, if you wish to run the test suite on a branch prior to
117117
submitting the Pull Request, then Travis-CI needs to be hooked up to your
118118
GitHub repository. Instructions are for doing so are `here
119-
<http://about.travis-ci.org/docs/user/getting-started/>`_.
119+
<http://about.travis-ci.org/docs/user/getting-started/>`__.
120120

121121
Creating a Branch
122122
-----------------
@@ -219,7 +219,7 @@ To return to you home root environment:
219219
deactivate
220220

221221
See the full ``conda`` docs `here
222-
<http://conda.pydata.org/docs>`_.
222+
<http://conda.pydata.org/docs>`__.
223223

224224
At this point you can easily do an *in-place* install, as detailed in the next section.
225225

@@ -372,7 +372,7 @@ If you want to do a full clean build, do::
372372
Starting with 0.13.1 you can tell ``make.py`` to compile only a single section
373373
of the docs, greatly reducing the turn-around time for checking your changes.
374374
You will be prompted to delete `.rst` files that aren't required. This is okay
375-
since the prior version can be checked out from git, but make sure to
375+
since the prior version can be checked out from git, but make sure to
376376
not commit the file deletions.
377377

378378
::
@@ -401,7 +401,7 @@ Built Master Branch Documentation
401401
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
402402

403403
When pull-requests are merged into the pandas *master* branch, the main parts of the documentation are
404-
also built by Travis-CI. These docs are then hosted `here <http://pandas-docs.github.io/pandas-docs-travis>`_.
404+
also built by Travis-CI. These docs are then hosted `here <http://pandas-docs.github.io/pandas-docs-travis>`__.
405405

406406
Contributing to the code base
407407
=============================

doc/source/install.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ pandas at all.
3535
Simply create an account, and have access to pandas from within your brower via
3636
an `IPython Notebook <http://ipython.org/notebook.html>`__ in a few minutes.
3737

38-
.. _install.anaconda
38+
.. _install.anaconda:
3939

4040
Installing pandas with Anaconda
4141
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -68,7 +68,7 @@ admin rights to install it, it will install in the user's home directory, and
6868
this also makes it trivial to delete Anaconda at a later date (just delete
6969
that folder).
7070

71-
.. _install.miniconda
71+
.. _install.miniconda:
7272

7373
Installing pandas with Miniconda
7474
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/source/visualization.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -220,8 +220,8 @@ Histogram can be drawn specifying ``kind='hist'``.
220220

221221
.. ipython:: python
222222
223-
df4 = pd.DataFrame({'a': randn(1000) + 1, 'b': randn(1000),
224-
'c': randn(1000) - 1}, columns=['a', 'b', 'c'])
223+
df4 = pd.DataFrame({'a': np.random.randn(1000) + 1, 'b': np.random.randn(1000),
224+
'c': np.random.randn(1000) - 1}, columns=['a', 'b', 'c'])
225225
226226
plt.figure();
227227

pandas/core/strings.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -813,7 +813,7 @@ def str_strip(arr, to_strip=None, side='both'):
813813

814814

815815
def str_wrap(arr, width, **kwargs):
816-
"""
816+
r"""
817817
Wrap long strings in the Series/Index to be formatted in
818818
paragraphs with length less than a given width.
819819

0 commit comments

Comments
 (0)