Add documentation for Pipeline::sub_pipeline

eth-cscs · Sep 26, 2023 · 91d03cd · 91d03cd
1 parent d9db5f8
commit 91d03cd
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/include/dlaf/common/pipeline.h b/include/dlaf/common/pipeline.h
@@ -66,8 +66,10 @@ class Pipeline {
     return pipeline->read();
   }
 
-  // TODO: Documentation.
-  // TODO: Name?
+  /// Create a sub pipeline to the value contained in the current Pipeline
+  ///
+  /// All accesses to the sub pipeline are sequenced after previous accesses and before later accesses to
+  /// the original pipeline, independently of when values are accessed in the sub pipeline.
   Pipeline sub_pipeline() {
     namespace ex = pika::execution::experimental;