From b4b7845fa5115bcf0ef2afa3ddbdf499a43658f1 Mon Sep 17 00:00:00 2001 From: James Frost Date: Fri, 4 Aug 2023 11:01:36 +0100 Subject: [PATCH 1/3] Add collapse operator to reference docs Fixes #184 --- docs/source/reference/operators.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/reference/operators.rst b/docs/source/reference/operators.rst index fd1b635cd..34714d146 100644 --- a/docs/source/reference/operators.rst +++ b/docs/source/reference/operators.rst @@ -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 -------------------------- From b17514ed9dc527e70f118d28650ab0ec579f5a16 Mon Sep 17 00:00:00 2001 From: James Frost Date: Fri, 4 Aug 2023 11:02:20 +0100 Subject: [PATCH 2/3] Add reference docs for internal functions --- docs/source/reference/index.rst | 3 ++- docs/source/reference/internal.rst | 36 ++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 docs/source/reference/internal.rst diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 823f26daf..3c81afb1c 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -8,5 +8,6 @@ components. :maxdepth: 2 cli - operators recipe-format + operators + internal diff --git a/docs/source/reference/internal.rst b/docs/source/reference/internal.rst new file mode 100644 index 000000000..da0762548 --- /dev/null +++ b/docs/source/reference/internal.rst @@ -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: From 1a7ff7b8961432416ecf594d70df5c0ee9ff4858 Mon Sep 17 00:00:00 2001 From: James Frost Date: Fri, 4 Aug 2023 11:19:05 +0100 Subject: [PATCH 3/3] Cleanup docstring --- src/CSET/operators/misc.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/CSET/operators/misc.py b/src/CSET/operators/misc.py index bde4f960a..4f6d30837 100644 --- a/src/CSET/operators/misc.py +++ b/src/CSET/operators/misc.py @@ -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