Skip to content

DOC fixes in contributing.rst #15887

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
Apr 4, 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
14 changes: 7 additions & 7 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -536,10 +536,10 @@ signatures and add deprecation warnings where needed.

.. _contributing.ci:

Testing Thru Continuous Integration
Testing With Continuous Integration
-----------------------------------

The *pandas* testing suite will run automatically on `Travis-CI <https://travis-ci.org/>`__,
The *pandas* test suite will run automatically on `Travis-CI <https://travis-ci.org/>`__,
`Appveyor <https://www.appveyor.com/>`__, and `Circle CI <https://circleci.com/>`__ continuous integration
services, once your pull request is submitted.
However, if you wish to run the test suite on a branch prior to submitting the pull request,
Expand All @@ -548,14 +548,14 @@ for `Travis-CI <http://about.travis-ci.org/docs/user/getting-started/>`__,
`Appveyor <https://www.appveyor.com/docs/>`__ , and `CircleCI <https://circleci.com/>`__.

A pull-request will be considered for merging when you have an all 'green' build. If any tests are failing,
then you will get a red 'X', where you can click thru to see the individual failed tests.
then you will get a red 'X', where you can click through to see the individual failed tests.
This is an example of a green build.

.. image:: _static/ci.png

.. note::

Each time you push to *your* fork, a *new* run of the tests will trigger on the CI. Appveyor will auto-cancel
Each time you push to *your* fork, a *new* run of the tests will be triggered on the CI. Appveyor will auto-cancel
any non-currently-running tests for that same pull-request. You can enable the auto-cancel feature for
`Travis-CI here <https://docs.travis-ci.com/user/customizing-the-build/#Building-only-the-latest-commit>`__ and
for `CircleCI here <https://circleci.com/changelog-legacy/#option-to-auto-cancel-redundant-builds>`__.
Expand Down Expand Up @@ -623,12 +623,12 @@ testing of many cases in a concise way that enables an easy-to-read syntax.

.. note::

.. code-block:: python
*pandas* existing test structure is *mostly* classed based, meaning that you will typically find tests wrapped in a class, inheriting from ``tm.TestCase``.

*pandas* existing test structure is *mostly* classed based, meaning that you will typically find tests wrapped in a class, inheriting from ``tm.TestCase``.
.. code-block:: python

class TestReallyCoolFeature(tm.TestCase):
....
....

Going forward we are moving to a more *functional* style, please see below.

Expand Down
2 changes: 1 addition & 1 deletion pandas/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
If True, performs operation inplace and returns None.""",
unique='np.ndarray', duplicated='Series',
optional_by='',
versionadded_to_excel='\n.. versionadded:: 0.20.0\n')
versionadded_to_excel='\n .. versionadded:: 0.20.0\n')


def _coerce_method(converter):
Expand Down
8 changes: 4 additions & 4 deletions pandas/io/json/normalize.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,10 @@ def json_normalize(data, record_path=None, meta=None,
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