Skip to content

Commit d3f1ced

Browse files
max-sixtycrusaderky
authored andcommitted
small updates to the contributing.rst (it could use more) (#3193)
1 parent 58001d7 commit d3f1ced

File tree

1 file changed

+2
-15
lines changed

1 file changed

+2
-15
lines changed

doc/contributing.rst

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ equivalent. The easiest way to verify that your code is correct is to
469469
explicitly construct the result you expect, then compare the actual result to
470470
the expected correct result::
471471

472-
def test_constructor_from_0d(self):
472+
def test_constructor_from_0d():
473473
expected = Dataset({None: ([], 0)})[None]
474474
actual = DataArray(0)
475475
assert_identical(expected, actual)
@@ -508,8 +508,7 @@ features that we like to use.
508508
- to set a mark on a parameter, ``pytest.param(..., marks=...)`` syntax should be used
509509
- ``fixture``, code for object construction, on a per-test basis
510510
- using bare ``assert`` for scalars and truth-testing
511-
- ``tm.assert_series_equal`` (and its counter part ``tm.assert_frame_equal``), for xarray
512-
object comparisons.
511+
- ``assert_equal`` and ``assert_identical`` from the ``xarray.testing`` module for xarray object comparisons.
513512
- the typical pattern of constructing an ``expected`` and comparing versus the ``result``
514513

515514
We would name this file ``test_cool_feature.py`` and put in an appropriate place in the
@@ -744,18 +743,6 @@ Doing 'git status' again should give something like::
744743
# modified: /relative/path/to/file-you-added.py
745744
#
746745
747-
Finally, commit your changes to your local repository with an explanatory message.
748-
*Xarray* uses a convention for commit message prefixes and layout. Here are
749-
some common prefixes along with general guidelines for when to use them:
750-
751-
* ``ENH``: Enhancement, new functionality
752-
* ``BUG``: Bug fix
753-
* ``DOC``: Additions/updates to documentation
754-
* ``TST``: Additions/updates to tests
755-
* ``BLD``: Updates to the build process/scripts
756-
* ``PERF``: Performance improvement
757-
* ``CLN``: Code cleanup
758-
759746
The following defines how a commit message should be structured:
760747
761748
* A subject line with `< 72` chars.

0 commit comments

Comments
 (0)