From 43113fa543c1e2ffdf90eab8838696941cc7ffbe Mon Sep 17 00:00:00 2001 From: "Jens H. Nielsen" Date: Fri, 15 Feb 2019 20:28:23 +0100 Subject: [PATCH] Correct links --- docs/community/objects.rst | 4 ++-- docs/user/configuration.rst | 2 +- docs/user/intro.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/community/objects.rst b/docs/community/objects.rst index 3b37576f612e..0e0cb451cd32 100644 --- a/docs/community/objects.rst +++ b/docs/community/objects.rst @@ -23,7 +23,7 @@ to use. Normal text shows the container includes and uses of this object. - *actions* - DataManager - **DataServer** -- :ref:`loops` +- :ref:`loops_api` - actions: Parameter, Task, Wait, (Active)Loop - **ActiveLoop** @@ -36,7 +36,7 @@ to use. Normal text shows the container includes and uses of this object. Station ------- -Read more about :ref:`station`. +Read more about :ref:`station_api`. .. todo:: is this how we want it ? or like the one below ? diff --git a/docs/user/configuration.rst b/docs/user/configuration.rst index 9fdd653a57c6..290f5aa81318 100644 --- a/docs/user/configuration.rst +++ b/docs/user/configuration.rst @@ -85,7 +85,7 @@ There is the possibility to save to env variable, and current working directory. More ~~~~ -For a overview of the API, read this: :ref:`config_label` . +For a overview of the API, read this: :ref:`config_api` . .. note:: for now are supported all the JSON types MINUS enum .. todo:: add GUI for creating config, explain saving (note on config loaded at module import so no effect if changed at runtime). diff --git a/docs/user/intro.rst b/docs/user/intro.rst index 7140319352b2..71da621b79a0 100644 --- a/docs/user/intro.rst +++ b/docs/user/intro.rst @@ -178,7 +178,7 @@ The key loop running conditions are: The Loop is responsible for: - creating the dataset_ that will be needed to store its data - - generating all the metadata for the DataSet. Metadata is intended to describe the system and software configuration to give it context, help reproduce and troubleshoot the experiment, and to aid searching and datamining later. The Loop generates its own metadata, regarding when and how it was run and the Parameters and other actions involved, as well as asking all the Instruments, via a :ref:`station` if possible, for their own metadata and including it. + - generating all the metadata for the DataSet. Metadata is intended to describe the system and software configuration to give it context, help reproduce and troubleshoot the experiment, and to aid searching and datamining later. The Loop generates its own metadata, regarding when and how it was run and the Parameters and other actions involved, as well as asking all the Instruments, via a :ref:`station_api` if possible, for their own metadata and including it. - sequencing actions: the Loop should have the highest priority and the least overhead of extra responsibilities so that setpoints and actions occur with as fast and reliable timing as possible. .. state