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. --- docs/user_guide/pipeline_input_context/context_definition.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/user_guide/pipeline_input_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 -- cgit v1.1 From e7d7c073d5ca505b79c321e32d451e5a71faf566 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Thu, 25 Apr 2024 21:06:57 +0200 Subject: Improving specific parameter documentation. --- docs/user_guide/pipeline_input_context/context_definition.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/user_guide/pipeline_input_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 c608532..7d30438 100644 --- a/docs/user_guide/pipeline_input_context/context_definition.md +++ b/docs/user_guide/pipeline_input_context/context_definition.md @@ -53,4 +53,5 @@ class Example(ArFeatures.ArContext): !!! note "" - The next chapter explains how to [load a context to connect it with a pipeline](configuration_and_connection.md). \ No newline at end of file + The next chapter explains how to [load a context to connect it with a pipeline](configuration_and_connection.md). + \ No newline at end of file -- cgit v1.1