Skip to content

Commit eb99bff

Browse files
committed
correct typos
1 parent 27fc93d commit eb99bff

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ gsw-xarray: Wrapper for gsw that adds CF attributes
1111

1212
gsw-xarray is a wrapper for `gsw python <https://github.com/TEOS-10/GSW-python>`_
1313
that will add CF attributes to xarray.DataArray outputs.
14-
It is meant to be a drop in wrapper for the upstram GSW-Python library and will only add these attribtues if the first argument to a fucntion is an xarray.DataArray.
14+
It is meant to be a drop in wrapper for the upstream GSW-Python library and will only add these attributes if the first argument to a function is an xarray.DataArray.
1515

1616
Usage
1717
-----
@@ -46,7 +46,7 @@ Don't worry about usage with non xarray array objects, just use in all places yo
4646
.. code:: python
4747
4848
sigma0 = gsw.sigma0(id * 10, id * 0.1 + 34)
49-
print(type(sigma0, sigma0)
49+
print(type(sigma0), sigma0)
5050
5151
Outputs
5252

@@ -68,7 +68,7 @@ Conda
6868
.....
6969

7070
For the moment gsw-xarray is not released in conda-forge, so you'll
71-
need to instal via pip: activate your conda environment, and then use ``pip install gsw_xarray``.
71+
need to install via pip: activate your conda environment, and then use ``pip install gsw_xarray``.
7272

7373
Pipenv
7474
......
@@ -82,7 +82,7 @@ Contributor guide
8282
All contributions, bug reports, bug fixes, documentation improvements,
8383
enhancements, and ideas are welcome.
8484
If you notice a bug or are missing a feature, fell free
85-
to open an issue in the `github issues page <https://github.com/DocOtak/gsw-xarray/issues>`_.
85+
to open an issue in the `GitHub issues page <https://github.com/DocOtak/gsw-xarray/issues>`_.
8686

8787
In order to contribute to gsw-xarray, please fork the repository and
8888
submit a pull request. A good step by step tutorial for starting with git can be found in the

docs/attrs.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ This rather long list shows all the attributes that will be set on the returned
44

55
There are some things to be aware of:
66

7-
* Functions which return unitless values will have the ``units`` attribute set to ``"1"`` folloing the CF recomended practice (based on SI).
7+
* Functions which return unitless values will have the ``units`` attribute set to ``"1"`` following the CF recommended practice (based on SI).
88
Rather than omit the ``units`` attribute entirely, we want to explicitly state that something is unitless.
99

10-
* The unit strings were selected to be compatable with both UDUNITS2 (the requrement in CF), and the python pint library.
10+
* The unit strings were selected to be compatible with both UDUNITS2 (the requirement in CF), and the python pint library.
1111

1212
* Not every returned value has a CF standard name, in which case we must not include the standard name attribute.
1313
As names are added to the CF table, we will attempt to update this list.
1414
The current standard names were taken from v78 last published on 2021-09-21.
1515

16-
Additionally, some standard names are only valid for speciifc input values e.g. z_from_p has geopotential parameters and the normal standard name does not apply if these are not 0.
16+
Additionally, some standard names are only valid for specific input values e.g. z_from_p has geopotential parameters and the normal standard name does not apply if these are not 0.
1717

1818
* We include the OceanSITES ``reference_scale`` attribute for functions that return PSS-78 or ITS-90.
1919

2020
* Finally, we did our best to include the correct units and standard name based on the published TEOS-10 documentation.
21-
If erorrs are noted, please open an issue on github so we can correct these errors.
21+
If errors are noted, please open an issue on GitHub so we can correct these errors.
2222

23-
.. include:: _attr_table.rst
23+
.. include:: _attr_table.rst

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
.. include:: ../README.rst
77

8-
For the specific list of what attribtues are added for each function, see the :ref:`attrs:Added Attributes` section.
8+
For the specific list of what attributes are added for each function, see the :ref:`attrs:Added Attributes` section.
99

1010
.. toctree::
1111
:maxdepth: 2

0 commit comments

Comments
 (0)