Add package and module docstrings explaining what is contained in each package/module and should go there
Module Docstrings should contain a description of the functionality the module provides (in an abstract way) and a short overview, how this functionality is implemented (e.g. which functions/classes do I typically need to use the functionality and when should I look at the other functions/classes). The latter part might not be sensible for AAS model modules.
Package docstrings should be added for the
aas.modelpackage and provide a high-level overview over the functionality the structure of this package, including the purpose of the single child modules/packages. It should answer the question: “which functionality regarding the AAS is implemented in the package and which (abstract) part of it can be found in which module?”. The docstring of
aasmight be overlapping with the README.md file, which should also explain the project structure.