Skip to content

Commit 60809ab

Browse files
author
Shammamah Hossain
committed
Replace 'optional' with default values for props that have them specified.
Replace 'optional' with default values for props that have them specified in metadata_test.
1 parent cc2253a commit 60809ab

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

tests/unit/development/metadata_test.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ class Table(Component):
1212
- children (a list of or a singular dash component, string or number; optional)
1313
- optionalArray (list; optional): Description of optionalArray
1414
- optionalBool (boolean; optional)
15-
- optionalNumber (number; optional)
15+
- optionalNumber (number; default 42)
1616
- optionalObject (dict; optional)
17-
- optionalString (string; optional)
17+
- optionalString (string; default 'hello world')
1818
- optionalNode (a list of or a singular dash component, string or number; optional)
1919
- optionalElement (dash component; optional)
2020
- optionalEnum (a value equal to: 'News', 'Photos'; optional)

tests/unit/development/test_base_component.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -881,9 +881,9 @@ def assert_docstring(assertEqual, docstring):
881881
"- children (a list of or a singular dash component, string or number; optional)", # noqa: E501
882882
"- optionalArray (list; optional): Description of optionalArray",
883883
"- optionalBool (boolean; optional)",
884-
"- optionalNumber (number; optional)",
884+
"- optionalNumber (number; default 42)",
885885
"- optionalObject (dict; optional)",
886-
"- optionalString (string; optional)",
886+
"- optionalString (string; default 'hello world')",
887887

888888
"- optionalNode (a list of or a singular dash component, "
889889
"string or number; optional)",
@@ -1040,8 +1040,8 @@ def assert_flow_docstring(assertEqual, docstring):
10401040
"",
10411041
"Keyword arguments:",
10421042
"- requiredString (string; required): A required string",
1043-
"- optionalString (string; optional): A string that isn't required.",
1044-
"- optionalBoolean (boolean; optional): A boolean test",
1043+
"- optionalString (string; default ''): A string that isn't required.",
1044+
"- optionalBoolean (boolean; default false): A boolean test",
10451045

10461046
"- optionalNode (a list of or a singular dash component, string or number; optional): "
10471047
"A node test",

0 commit comments

Comments
 (0)