Update module docstrings (#279)

facebookresearch · Nov 15, 2024 · bff4819 · bff4819
1 parent 547d94f
commit bff4819
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/spdl/dataloader/__init__.py b/src/spdl/dataloader/__init__.py
@@ -4,7 +4,7 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
-"""Utilities to run I/O operations efficiently."""
+"""Task specific data loading solutions based on :py:class:`~spdl.pipeline.Pipeline`."""
 
 # pyre-unsafe
 

diff --git a/src/spdl/pipeline/__init__.py b/src/spdl/pipeline/__init__.py
@@ -4,7 +4,7 @@
 # This source code is licensed under the BSD-style license found in the
 # LICENSE file in the root directory of this source tree.
 
-"""Utilities to run I/O operations efficiently."""
+"""Implements :py:class:`~spdl.pipeline.Pipeline`, a generic task execution engine."""
 
 # pyre-unsafe