Given how central the functionality in context.py is to interlab, the core classes and functions in this module should be better documented.
context: While playing with the contexts_intro.ipynb I found myself wanting to understand certain parts of the Context class better but couldn't find documentation to help me understand. Some things I would have wanted to understand from the docs:
What is Context.kind and how does it relate to the _type after serialization?
What is Context.meta?
What is Context.directory?
What do the different ContextStates mean?
What are the restrictions on Tag.color?
Which data types are allowed inside a context if I don't want Context.to_dict to break?
gavento
commented
11 months ago
Given how central the functionality in
context.pyis to interlab, the core classes and functions in this module should be better documented.context: While playing with the
contexts_intro.ipynbI found myself wanting to understand certain parts of the Context class better but couldn't find documentation to help me understand. Some things I would have wanted to understand from the docs:Context.kindand how does it relate to the_typeafter serialization?Context.meta?Context.directory?ContextStates mean?Tag.color?Context.to_dictto break?