From 350cbb2a0b2ca673c6c72df6bf4dd1ab562b2ade Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Thu, 25 Apr 2024 21:04:19 +0200 Subject: Improving documentation. --- .../user_guide/pipeline_input_context/configuration_and_connection.md | 2 +- docs/user_guide/pipeline_input_context/context_definition.md | 4 ++-- docs/user_guide/pipeline_input_context/introduction.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/user_guide/pipeline_input_context') diff --git a/docs/user_guide/pipeline_input_context/configuration_and_connection.md b/docs/user_guide/pipeline_input_context/configuration_and_connection.md index 392860f..4aac88a 100644 --- a/docs/user_guide/pipeline_input_context/configuration_and_connection.md +++ b/docs/user_guide/pipeline_input_context/configuration_and_connection.md @@ -5,7 +5,7 @@ Once an [ArContext is defined](context_definition.md), it have to be connected t # Load JSON configuration file -An [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) can be loaded from a JSON configuration file thanks to the argaze.load package method. +An [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) can be loaded from a JSON configuration file thanks to the [argaze.load](../../argaze.md/#argaze.load) package method. Here is a JSON configuration file related to the [previously defined Example context](context_definition.md): diff --git a/docs/user_guide/pipeline_input_context/context_definition.md b/docs/user_guide/pipeline_input_context/context_definition.md index 5456243..c608532 100644 --- a/docs/user_guide/pipeline_input_context/context_definition.md +++ b/docs/user_guide/pipeline_input_context/context_definition.md @@ -25,7 +25,7 @@ class Example(ArFeatures.ArContext): @property def parameter(self): - """Any required parameter.""" + """Any context specific parameter.""" return self.__parameter @parameter.setter @@ -35,7 +35,7 @@ class Example(ArFeatures.ArContext): @DataFeatures.PipelineStepEnter def __enter__(self): - # Start context according any required parameter + # Start context according any specific parameter ... self.parameter # Assuming that timestamp, x and y values are available diff --git a/docs/user_guide/pipeline_input_context/introduction.md b/docs/user_guide/pipeline_input_context/introduction.md index 76c560e..e31ad54 100644 --- a/docs/user_guide/pipeline_input_context/introduction.md +++ b/docs/user_guide/pipeline_input_context/introduction.md @@ -14,7 +14,7 @@ To build your own input context, you need to know: !!! warning "Documentation in progress" - This section is not yet fully done. Please look at the [demo](../utils/demonstrations_scripts.md) to know more about this notion. + This section is not yet fully done. Please look at the [demonstrations scripts chapter](../utils/demonstrations_scripts.md) to know more about this notion.