Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the type registration system #22

Open
4 tasks
muhrin opened this issue May 19, 2022 · 0 comments
Open
4 tasks

Document the type registration system #22

muhrin opened this issue May 19, 2022 · 0 comments
Assignees

Comments

@muhrin
Copy link
Owner

muhrin commented May 19, 2022

Currently, mincePy is conservative with discovering compatible types, essentially relying on manual register_type() calls, or assuming that when the users calls save() that they want to register that type helper if it is not already registered. There is a plugin system that uses setup.py endpoints to automatically discover types but this is entirely undocumented.

The documentation should be extended to include:

  • Information on when types will be registered (and when to manually register)
  • An explanation of why the historian adopts the behaviour it does
  • Documentation of the type discovery endpoint hooks
  • Advice on what to use as TYPE_IDs and in which situations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant