phetsims / tandem

Simulation-side code for PhET-iO
MIT License
0 stars 5 forks source link

Bring documentation up to standards in IOType.ts and StateSchema.ts #283

Closed pixelzoom closed 1 year ago

pixelzoom commented 1 year ago

While working on #282, @samreid and I discovered that documentation for IOType.ts and StateSchema.ts is not up to standards. And that's one of the things that's making IOTypes difficult to use.

For example:

samreid commented 1 year ago

Tagging for https://github.com/phetsims/phet-io/issues/1914 and self-unassigning.

zepumph commented 1 year ago

Many updates above. The only thing I didn't do was move the documentation from the options to the field declarations. I think it is clearer in the options definition. Please review.

pixelzoom commented 1 year ago

Much better, thanks. One additional bit of doc in the above commit.

If work is done here, feel free to close.