-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add cross-links to API docstring from tutorial and user-guide #8311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
2aacea4
805d3e3
0eaf010
35912ca
a26ea13
104855d
b8e88f2
a1c6578
cebc32b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5435,6 +5435,9 @@ def map_blocks( | |
dask.array.map_blocks, xarray.apply_ufunc, xarray.Dataset.map_blocks | ||
xarray.DataArray.map_blocks | ||
|
||
`**Tutorial on map_blocks** <https://tutorial.xarray.dev/advanced/map_blocks/map_blocks.html>`_ | ||
Advanced Tutorial on map_blocks with dask | ||
|
||
Examples | ||
-------- | ||
Calculate an anomaly from climatology using ``.groupby()``. Using | ||
|
@@ -6650,10 +6653,20 @@ def groupby( | |
-------- | ||
:ref:`groupby` | ||
Users guide explanation of how to group and bin data. | ||
|
||
`Deconstructing GroupBy operation <https://tutorial.xarray.dev/intermediate/01-high-level-computation-patterns.html#label-space-windows-or-bins-groupby>`_ | ||
Tutorial on :py:func:`~xarray.DataArray.Groupby` for windowed computation | ||
|
||
`Grouped Computation <https://tutorial.xarray.dev/fundamentals/03.2_groupby_with_xarray.html>`_ | ||
Tutorial on :py:func:`~xarray.DataArray.Groupby` demonstrating reductions, transformation and comparison with :py:func:`~xarray.DataArray.resample` | ||
|
||
DataArray.groupby_bins | ||
Dataset.groupby | ||
core.groupby.DataArrayGroupBy | ||
DataArray.coarsen | ||
pandas.DataFrame.groupby | ||
Dataset.resample | ||
DataArray.resample | ||
""" | ||
from xarray.core.groupby import ( | ||
DataArrayGroupBy, | ||
|
@@ -6788,6 +6801,13 @@ def weighted(self, weights: DataArray) -> DataArrayWeighted: | |
See Also | ||
-------- | ||
Dataset.weighted | ||
|
||
`Weighted array reductions <https://docs.xarray.dev/en/stable/user-guide/computation.html#weighted-array-reductions>`_ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. you can use :std:label:`/user-guide/computation.rst#weighted-array-reductions` (though maybe we need to add label directives to .. _weighted-array-reductions: just before that section... not sure if There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. many thanks! I made the necessary changes. |
||
User guide on weighted array reduction using :py:func:`~xarray.DataArray.weighted` | ||
|
||
`Weighted reduction <https://tutorial.xarray.dev/fundamentals/03.4_weighted.html>`_ | ||
Tutorial on Weighted Reduction using :py:func:`~xarray.DataArray.weighted` | ||
|
||
""" | ||
from xarray.core.weighted import DataArrayWeighted | ||
|
||
|
@@ -6929,6 +6949,16 @@ def coarsen( | |
-------- | ||
core.rolling.DataArrayCoarsen | ||
Dataset.coarsen | ||
|
||
`Reshaping via coarsen <https://docs.xarray.dev/en/stable/user-guide/reshaping.html#reshaping-via-coarsen>`_ | ||
User guide describing :py:func:`~xarray.DataArray.coarsen` | ||
|
||
`Coarsening large arrays <https://docs.xarray.dev/en/stable/user-guide/computation.html#coarsen-large-arrays>`_ | ||
User guide on block arrgragation :py:func:`~xarray.DataArray.coarsen` | ||
|
||
`Block window operation and reshaping <https://tutorial.xarray.dev/fundamentals/03.3_windowed.html?#coarsening>`_ | ||
Tutorial on windowed computation using :py:func:`~xarray.DataArray.coarsen` | ||
|
||
""" | ||
from xarray.core.rolling import DataArrayCoarsen | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -852,6 +852,7 @@ def __init__( | |
Returns | ||
------- | ||
coarsen | ||
|
||
""" | ||
self.obj = obj | ||
self.windows = windows | ||
|
Uh oh!
There was an error while loading. Please reload this page.