chore: descritpion.md are now optional

Signed-off-by: ThibaultFy <[email protected]>
Substra · Jun 19, 2024 · 0103e88 · 0103e88
1 parent d530023
commit 0103e88
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/references/sdk_schemas.md b/references/sdk_schemas.md
@@ -33,10 +33,11 @@ the 'paths' field.
 Specification for creating a dataset
 
 note : metadata field does not accept strings containing '__' as dict key
+note : If no description markdown file is given, create an empty one on the data_opener folder.
 ```text
 - name: <class 'str'>
 - data_opener: <class 'pathlib.Path'>
-- description: <class 'pathlib.Path'>
+- description: typing.Optional[pathlib.Path]
 - permissions: <class 'substra.sdk.schemas.Permissions'>
 - metadata: typing.Optional[typing.Dict[str, str]]
 - logs_permission: <class 'substra.sdk.schemas.Permissions'>

diff --git a/substra/sdk/schemas.py b/substra/sdk/schemas.py
@@ -286,11 +286,12 @@ class DatasetSpec(_Spec):
     """Specification for creating a dataset
 
     note : metadata field does not accept strings containing '__' as dict key
+    note : If no description markdown file is given, create an empty one on the data_opener folder.
     """
 
     name: str
     data_opener: pathlib.Path  # Path to the data opener
-    description: Optional[pathlib.Path] = None  # Path to the description file
+    description: Optional[pathlib.Path] = None  # Path to the description file.
     permissions: Permissions
     metadata: Optional[Dict[str, str]] = None
     logs_permission: Permissions