Skip to content

Commit 8eeb61e

Browse files
authored
Merge pull request #37 from chrishavlin/docs_typos
fixing some docs typos
2 parents 8a9dc62 + 468aa2a commit 8eeb61e

5 files changed

Lines changed: 26 additions & 3 deletions

File tree

docs/examples/example_005_chunked_data.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@
172172
"source": [
173173
"## yt_xarray and Dask chunks\n",
174174
"\n",
175-
"While yt_xarray can handle chunked xarray fields, the current implementation does guarantee alignment between yt and xarray chunks. This means that when using a Dask backend, yt may request index ranges that span dask chunks when operating on yt grid objects. To illustrate this, let's first build an xarray dataset with a single field defined by a dask array:"
175+
"While yt_xarray can handle chunked xarray fields, the current implementation does not guarantee alignment between yt and xarray chunks. This means that when using a Dask backend, yt may request index ranges that span dask chunks when operating on yt grid objects. To illustrate this, let's first build an xarray dataset with a single field defined by a dask array:"
176176
]
177177
},
178178
{

docs/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ coordinate aliasing (see `above <#unknown-coordinate-names>`_), it is important
5050
will successfully run, the results may be unexpected. Many of yt's analysis routines
5151
involve projecting or volume-averaging, which would yield incorrect results when
5252
treating, for example, a pressure-coordinate as a length. Generally, the functionality
53-
that will work is that related to data selection such as plotting slices (``yt.SlicePlot()`),
53+
that will work is that related to data selection such as plotting slices (``yt.SlicePlot()``),
5454
subselecting data or finding extrema. Some methods, like ``yt.PhasePlot()`` may work
5555
if care is taken to set the averaging keyword arguments appropriately.
5656

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To get started check out the following pages:
2121
supported_grids
2222
examples
2323
faq
24-
modules
24+
API <modules>
2525
contributing
2626

2727
Indices and tables

docs/yt_xarray.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Subpackages
77
.. toctree::
88

99
yt_xarray.accessor
10+
yt_xarray.utilities
1011

1112
Submodules
1213
----------

docs/yt_xarray.utilities.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
yt\_xarray.utilities package
2+
============================
3+
4+
Submodules
5+
----------
6+
7+
yt\_xarray.utilities.logging module
8+
-----------------------------------
9+
10+
.. automodule:: yt_xarray.utilities.logging
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
16+
Module contents
17+
---------------
18+
19+
.. automodule:: yt_xarray.utilities
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

0 commit comments

Comments
 (0)