Skip to content

Commit faf6401

Browse files
jorisvandenbosschejreback
authored andcommitted
DOC fixes in contributing.rst (#15887)
1 parent da0523a commit faf6401

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

doc/source/contributing.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -536,10 +536,10 @@ signatures and add deprecation warnings where needed.
536536

537537
.. _contributing.ci:
538538

539-
Testing Thru Continuous Integration
539+
Testing With Continuous Integration
540540
-----------------------------------
541541

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

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

554554
.. image:: _static/ci.png
555555

556556
.. note::
557557

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

624624
.. note::
625625

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

628-
*pandas* existing test structure is *mostly* classed based, meaning that you will typically find tests wrapped in a class, inheriting from ``tm.TestCase``.
628+
.. code-block:: python
629629
630630
class TestReallyCoolFeature(tm.TestCase):
631-
....
631+
....
632632
633633
Going forward we are moving to a more *functional* style, please see below.
634634

pandas/core/series.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
If True, performs operation inplace and returns None.""",
8181
unique='np.ndarray', duplicated='Series',
8282
optional_by='',
83-
versionadded_to_excel='\n.. versionadded:: 0.20.0\n')
83+
versionadded_to_excel='\n .. versionadded:: 0.20.0\n')
8484

8585

8686
def _coerce_method(converter):

pandas/io/json/normalize.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,10 @@ def json_normalize(data, record_path=None, meta=None,
114114
meta_prefix : string, default None
115115
errors : {'raise', 'ignore'}, default 'raise'
116116
117-
* ignore : will ignore KeyError if keys listed in meta are not
118-
always present
119-
* raise : will raise KeyError if keys listed in meta are not
120-
always present
117+
* 'ignore' : will ignore KeyError if keys listed in meta are not
118+
always present
119+
* 'raise' : will raise KeyError if keys listed in meta are not
120+
always present
121121
122122
.. versionadded:: 0.20.0
123123

0 commit comments

Comments
 (0)