Skip to content

Commit 063606b

Browse files
authored
Fix grammar and typos in contributing guide (#4545)
* Fix grammar and typos in contributing guide * Add whats-new entry
1 parent 1808be4 commit 063606b

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

doc/contributing.rst

+13-13
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ report will allow others to reproduce the bug and provide insight into fixing. S
4040
`this stackoverflow article <https://stackoverflow.com/help/mcve>`_ for tips on
4141
writing a good bug report.
4242

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
4545
pull requests to see if the issue has already been reported and/or fixed.
4646

4747
Bug reports must:
@@ -189,7 +189,7 @@ Creating a branch
189189
-----------------
190190

191191
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::
193193

194194
git branch shiny-new-feature
195195
git checkout shiny-new-feature
@@ -211,7 +211,7 @@ To update this branch, you need to retrieve the changes from the master branch::
211211
This will combine your commits with the latest *xarray* git master. If this
212212
leads to merge conflicts, you must resolve these before submitting your pull
213213
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
215215
reapplied after updating.
216216

217217
.. _contributing.documentation:
@@ -277,7 +277,7 @@ Some other important things to know about the docs:
277277

278278
Almost all code examples in the docs are run (and the output saved) during the
279279
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.
281281

282282
- Our API documentation in ``doc/api.rst`` houses the auto-generated
283283
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/``.
318318

319319
The first time you build the docs, it will take quite a while because it has to run
320320
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.
322322

323323
If you want to do a full clean build, do::
324324

@@ -366,7 +366,7 @@ xarray uses several tools to ensure a consistent code format throughout the proj
366366

367367
pip install black flake8 isort mypy blackdoc
368368

369-
and then run from the root of the Xarray repository::
369+
and then run from the root of the xarray repository::
370370

371371
isort .
372372
black -t py36 .
@@ -440,7 +440,7 @@ taken from the original GitHub issue. However, it is always worth considering a
440440
use cases and writing corresponding tests.
441441

442442
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.
444444

445445
Like many packages, *xarray* uses `pytest
446446
<http://doc.pytest.org/en/latest/>`_ and the convenient
@@ -625,7 +625,7 @@ need to install `pytest-xdist` via::
625625
pip install pytest-xdist
626626
627627
628-
Then, run pytest with the optional -n argument:
628+
Then, run pytest with the optional -n argument::
629629
630630
pytest xarray -n 4
631631
@@ -812,7 +812,7 @@ release. To submit a pull request:
812812
This request then goes to the repository maintainers, and they will review
813813
the code. If you need to make more changes, you can make them in
814814
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::
816816
817817
git push origin shiny-new-feature
818818
@@ -836,9 +836,9 @@ Then you can do::
836836
837837
You need to use a upper-case ``-D`` because the branch was squashed into a
838838
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.
840840
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
842842
GitHub. To delete it there do::
843843
844844
git push origin --delete shiny-new-feature
@@ -860,4 +860,4 @@ PR checklist
860860
- Run ``flake8`` in the root directory. If this fails, it will log an error message.
861861
862862
- **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>`_.

doc/whats-new.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ Documentation
6868
- Raise a more informative error when :py:meth:`DataArray.to_dataframe` is
6969
is called on a scalar, (:issue:`4228`);
7070
By `Pieter Gijsbers <https://github.com/pgijsbers>`_.
71-
71+
- Fix grammar and typos in the :doc:`contributing` guide (:pull:`4545`).
72+
By `Sahid Velji <https://github.com/sahidvelji>`_.
7273

7374
Internal Changes
7475
~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)