Procc docstr example (#96)

* Example of new processors docstring Signed-off-by: George <[email protected]> * Example of processor docstr [new style], on DuplicateFields Signed-off-by: George <[email protected]> --------- Signed-off-by: George <[email protected]>
NVIDIA · Dec 17, 2024 · 420e18a · 420e18a
1 parent caad20f
commit 420e18a
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/sdp/processors/modify_manifest/common.py b/sdp/processors/modify_manifest/common.py
@@ -144,9 +144,17 @@ class DuplicateFields(BaseParallelProcessor):
 
     Returns:
         The same data as in the input manifest with duplicated fields
-        as specified in the ``duplicate_fields`` input dictionary.
-    """
+        as specified in the ``duplicate_fields`` input dictionary. 
+    
+    Example:
+        .. code-block:: yaml
+
+            - _target_: sdp.processors.modify_manifest.common.DuplicateFields
+              input_manifest_file: ${workspace_dir}/test1.json
+              output_manifest_file: ${workspace_dir}/test2.json
+              duplicate_fields: {"text":"answer"}
 
+    """
     def __init__(
         self,
         duplicate_fields: Dict,