Contributions new types to visions¶
visions is a continuously evolving project with the aim of expanding it’s set of useful semantic types. To that end, if you find a type construction useful, please feel free to contribute it back here.
Below you will find a checklist with instructions on which files to add or modify.
Type implementation:
place the type implementation in src/visions/types/[your type_name].py
include the type in src/visions/types/__init__.py
include the type in a relevant typeset, or create one src/visions/typesets/[your_typeset].py
Tests:
add series to tests/series.py that test the type
add series to tests/series.py that test the each relation
Documentation:
provide informative docstrings src/visions/types/[your type_name].py
include the type in the api documentation: docsrc/source/visions/api/types.rst
add a row to the defaults table: docsrc/source/visions/practitioner/defaults.rst