Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Document collapse operator #185

Merged
merged 3 commits into from
Aug 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/source/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ components.
:maxdepth: 2

cli
operators
recipe-format
operators
internal
36 changes: 36 additions & 0 deletions docs/source/reference/internal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Internal Functions
==================

This page details various internal functions within CSET. Most people should
never have to worry about these, but they are documented here for the
convenience of those developing CSET.

CSET.operators
--------------

.. automodule:: CSET.operators
:members:

CSET.recipes
------------

.. automodule:: CSET.recipes
:members:

CSET.graph
----------

.. automodule:: CSET.graph
:members:

CSET._common
------------

.. note::

While no functions documented on this page are part of any API promise, the
functions inside _common are especially liable to change without any kind of
notice.

.. automodule:: CSET._common
:members:
6 changes: 6 additions & 0 deletions docs/source/reference/operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ This page details the operators contained within CSET. It is automatically
generated from the code and its docstrings. Operators should be used via
:doc:`/usage/operator-recipes`.

CSET.operators.collapse
-----------------------

.. automodule:: CSET.operators.collapse
:members:

CSET.operators.constraints
--------------------------

Expand Down
3 changes: 1 addition & 2 deletions src/CSET/operators/misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,10 @@ def noop(x, **kwargs):
x: Any
Input to return.

Will silently accept any additional keyword arguments for testing purposes.

Returns
-------
x: Any
The input that was given.
"""

return x