From 602a460ce3005d21bed7c55bb6a6806e0b39f05f Mon Sep 17 00:00:00 2001 From: Filipe Fernandes Date: Wed, 15 Jun 2022 16:15:45 -0300 Subject: [PATCH] use :mod: directive to fix links --- docs/source/usage.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 045ea3a8..4d0aa726 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -5,9 +5,9 @@ At its core, ``ioos_qc`` is a collection of modules and methods to run various q The following implementations are available in ``ioos_qc``: -* `IOOS QARTOD `_ - `API `_ -* `ARGO - API `_ -* `AXDS - API `_ - A collection of checks used by `Axiom Data Science `_ +* `IOOS QARTOD `_ - :mod:`API ` +* :mod:`ARGO - API ` +* :mod:`AXDS - API ` - A collection of checks used by `Axiom Data Science `_ Basic usage ----------- @@ -211,7 +211,7 @@ Usage Streams ------- -Streams represent the data input types for running quality control tests. A user "runs" a stream of data through a collection of quality control tests defined by a Config_. A list of possible Streams can be found in the `Streams API `_. +Streams represent the data input types for running quality control tests. A user "runs" a stream of data through a collection of quality control tests defined by a Config_. A list of possible Streams can be found in the :mod:`Streams API `. All streams return a generator of QC results that contain contextual information that can be useful when using the results. You can iterate over the results generator directly or you can collect them into more familiar ``list`` or ``dict`` objects before usage. If you are working in a streaming environment you will want to use generator result objects yourself. If you are running one-time or batch process quality checks you likely want to collect the results or use one of the Stores_ provided by ``ioos_qc``. @@ -225,7 +225,7 @@ working in a streaming environment you will want to use generator result objects Results ~~~~~~~ -Each yielded result will be a `StreamConfigResult `_ or a `ContextResult `_, depending on which type of Config_ object was used. Collected results are only ever of one type, a `CollectedResult `_, and only one ``CollectedResult`` will be returned after collecting Results. The benefit of using a ``CollectedResult`` is that it will piece back together all of the different ContextConfig_ objects in a Config_ and return you one result per unique ``stream_id`` and module/test combination. +Each yielded result will be a :mod:`StreamConfigResult ` or a :mod:`ContextResult `, depending on which type of Config_ object was used. Collected results are only ever of one type, a :mod:`CollectedResult `, and only one ``CollectedResult`` will be returned after collecting Results. The benefit of using a ``CollectedResult`` is that it will piece back together all of the different ContextConfig_ objects in a Config_ and return you one result per unique ``stream_id`` and module/test combination. .. note:: @@ -233,7 +233,7 @@ Each yielded result will be a `StreamConfigResult `_ should be used in any applications, including any implementation of Stores_, going forward. + Historically, test results were returned in a ``dict`` structure. While this is still supported it **should be considered deprecated**. The individually yielded result objects or a list of :mod:`CollectedResult objects ` should be used in any applications, including any implementation of Stores_, going forward. .. code-block:: python @@ -517,7 +517,7 @@ A subset of the NumpyStream, the NetcdfStream simply extracts numpy arrays from Stores ------ -Stores represent different data formats for storing quality control Results_ from Streams_. The results from any ``Stream`` should be able to be passed into any ``Store`` implementation defined in the `Stores API `_. +Stores represent different data formats for storing quality control Results_ from Streams_. The results from any ``Stream`` should be able to be passed into any ``Store`` implementation defined in the :mod:`Stores API `. ``ioos_qc`` comes with some built-in Stores_: