Skip to content

Commit c1add40

Browse files
committed
Add conclusion about required field documentation into design patterns doc. #116 (comment)
1 parent ee32249 commit c1add40

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/phet-software-design-patterns.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,8 @@ function Person( name, config ) {
829829
}
830830
```
831831
In some cases, it may be better to only indicate the `required` properties or only indicate the `optional` properties,
832-
or to group them -- use your judgment.
832+
or to group them -- use your judgment. Note that documentation is above the required config field and within the config object.
833+
The required() function is enough indication that this is a required field in the config object and no further distinction is required in the documentation.
833834

834835
### Best Practices
835836

0 commit comments

Comments
 (0)