markgw / pimlico

The Pimlico Processing Toolkit
http://pimlico.readthedocs.org/
GNU Lesser General Public License v3.0
6 stars 1 forks source link

Document new datatype functionality #5

Closed markgw closed 6 years ago

markgw commented 7 years ago

1 will require a fairly major update of the docs. It should be mainly tweaks, but you'll need to find anywhere where datatypes are mentioned, e.g. how to create datatypes, how to use them in module code, how to define input modules from datatypes, ...

If there isn't one already (I can't remember), there should be a basic doc about how datatypes function, explaining the new system of readers and writers, and how to define your own, including an explanation of typechecking. Some of this can be taken from the notes on #1, describing the new system to be implemented.

markgw commented 6 years ago

Added new document in a6c79edfe2fb7f7a8921d7cc652c4b6f737d079d and updated docstrings so datatypes are now properly documented.