You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/contributing.rst
+13-13
Original file line number
Diff line number
Diff line change
@@ -40,8 +40,8 @@ report will allow others to reproduce the bug and provide insight into fixing. S
40
40
`this stackoverflow article <https://stackoverflow.com/help/mcve>`_ for tips on
41
41
writing a good bug report.
42
42
43
-
Trying the bug-producing code out on the *master* branch is often a worthwhile exercise
44
-
to confirm the bug still exists. It is also worth searching existing bug reports and
43
+
Trying out the bug-producing code on the *master* branch is often a worthwhile exercise
44
+
to confirm that the bug still exists. It is also worth searching existing bug reports and
45
45
pull requests to see if the issue has already been reported and/or fixed.
46
46
47
47
Bug reports must:
@@ -189,7 +189,7 @@ Creating a branch
189
189
-----------------
190
190
191
191
You want your master branch to reflect only production-ready code, so create a
192
-
feature branch for making your changes. For example::
192
+
feature branch before making your changes. For example::
193
193
194
194
git branch shiny-new-feature
195
195
git checkout shiny-new-feature
@@ -211,7 +211,7 @@ To update this branch, you need to retrieve the changes from the master branch::
211
211
This will combine your commits with the latest *xarray* git master. If this
212
212
leads to merge conflicts, you must resolve these before submitting your pull
213
213
request. If you have uncommitted changes, you will need to ``git stash`` them
214
-
prior to updating. This will effectively store your changes and they can be
214
+
prior to updating. This will effectively store your changes, which can be
215
215
reapplied after updating.
216
216
217
217
.. _contributing.documentation:
@@ -277,7 +277,7 @@ Some other important things to know about the docs:
277
277
278
278
Almost all code examples in the docs are run (and the output saved) during the
279
279
doc build. This approach means that code examples will always be up to date,
280
-
but it does make the doc building a bit more complex.
280
+
but it does make building the docs a bit more complex.
281
281
282
282
- Our API documentation in ``doc/api.rst`` houses the auto-generated
283
283
documentation from the docstrings. For classes, there are a few subtleties
@@ -318,7 +318,7 @@ Then you can find the HTML output in the folder ``xarray/doc/_build/html/``.
318
318
319
319
The first time you build the docs, it will take quite a while because it has to run
320
320
all the code examples and build all the generated docstring pages. In subsequent
321
-
evocations, sphinx will try to only build the pages that have been modified.
321
+
evocations, Sphinx will try to only build the pages that have been modified.
322
322
323
323
If you want to do a full clean build, do::
324
324
@@ -366,7 +366,7 @@ xarray uses several tools to ensure a consistent code format throughout the proj
366
366
367
367
pip install black flake8 isort mypy blackdoc
368
368
369
-
and then run from the root of the Xarray repository::
369
+
and then run from the root of the xarray repository::
370
370
371
371
isort .
372
372
black -t py36 .
@@ -440,7 +440,7 @@ taken from the original GitHub issue. However, it is always worth considering a
440
440
use cases and writing corresponding tests.
441
441
442
442
Adding tests is one of the most common requests after code is pushed to *xarray*. Therefore,
443
-
it is worth getting in the habit of writing tests ahead of time so this is never an issue.
443
+
it is worth getting in the habit of writing tests ahead of time so that this is never an issue.
444
444
445
445
Like many packages, *xarray* uses `pytest
446
446
<http://doc.pytest.org/en/latest/>`_ and the convenient
@@ -625,7 +625,7 @@ need to install `pytest-xdist` via::
625
625
pip install pytest-xdist
626
626
627
627
628
-
Then, run pytest with the optional -n argument:
628
+
Then, run pytest with the optional -n argument::
629
629
630
630
pytest xarray -n 4
631
631
@@ -812,7 +812,7 @@ release. To submit a pull request:
812
812
This request then goes to the repository maintainers, and they will review
813
813
the code. If you need to make more changes, you can make them in
814
814
your branch, add them to a new commit, push them to GitHub, and the pull request
815
-
will be automatically updated. Pushing them to GitHub again is done by::
815
+
will automatically be updated. Pushing them to GitHub again is done by::
816
816
817
817
git push origin shiny-new-feature
818
818
@@ -836,9 +836,9 @@ Then you can do::
836
836
837
837
You need to use a upper-case ``-D`` because the branch was squashed into a
838
838
single commit before merging. Be careful with this because ``git`` won't warn
839
-
you if you accidentally delete a unmerged branch.
839
+
you if you accidentally delete an unmerged branch.
840
840
841
-
If you didn't delete it using GitHub's interface, the branch will still exist on
841
+
If you didn't delete your branch using GitHub's interface, then it will still exist on
842
842
GitHub. To delete it there do::
843
843
844
844
git push origin --delete shiny-new-feature
@@ -860,4 +860,4 @@ PR checklist
860
860
- Run ``flake8`` in the root directory. If this fails, it will log an error message.
861
861
862
862
-**Push your code and** `create a PR on GitHub <https://help.github.com/en/articles/creating-a-pull-request>`_.
863
-
-**Use a helpful title for your pull request** by summarizing the main contributions rather than using the latest commit message. If this addresses an `issue <https://github.com/pydata/xarray/issues>`_, please `reference it <https://help.github.com/en/articles/autolinked-references-and-urls>`_.
863
+
-**Use a helpful title for your pull request** by summarizing the main contributions rather than using the latest commit message. If the PR addresses an `issue <https://github.com/pydata/xarray/issues>`_, please `reference it <https://help.github.com/en/articles/autolinked-references-and-urls>`_.
0 commit comments