Skip to content
Snippets Groups Projects
Commit 84981365 authored by Peter Lünenschloß's avatar Peter Lünenschloß
Browse files

updated the how-to-doc

parent 09369d59
No related branches found
No related tags found
5 merge requests!685Release 2.4,!684Release 2.4,!567Release 2.2.1,!566Release 2.2,!501Release 2.1
Pipeline #56496 passed with stage
in 1 minute and 45 seconds
......@@ -103,21 +103,15 @@ hyperlinking docstrings
.. code-block::
:py:func:`saqc.flagRange <saqc.Functions.flagRange>`
:py:func:`coolMethod <saqc.SaQC.flagRange>`
* Modules are available via the "simulated" package ``Functions.`` - for example:
.. code-block::
:py:mod:`generic <Functions.generic>`
* The saqc object and/or its content is available via:
.. code-block::
:py:class:`saqc.SaQC <Core.Core.SaQC>`
:py:meth:`saqc.SaQC.flagRange <Core.Core.SaQC.flagRange>`
:py:class:`saqc.SaQC`
:py:meth:`saqc.SaQC.flagRange`
* The Flags object and/or its content is available via:
......@@ -287,4 +281,19 @@ Will be rendered, as:
>>> time #doctest:+SKIP
CPU times: user 5 µs, sys: 3 µs, total: 8 µs
Wall time: 13.8 µs
\ No newline at end of file
Wall time: 13.8 µs
Run doctest locally
-------------------
Since doctest checks guard the push to the develop branch, you might wish to chek if your local modification passes
all doctests beforehand.
There for go to the sphinxdoc directory and run:
.. codebloc::
make testonly
To only run the doctests.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment