Current Situation
The documentation hasn't been updated in a while. For example, the main structure of the documentation includes methods defined in the __init__.py files, which makes it look disorganised:
|
def resolve_referable_class_in_key_types(referable: Referable) -> type: |
|
""" |
|
Returns the type of referable if the type is given in `KEY_TYPES_CLASSES`, otherwise return the first parent class |
|
in inheritance chain of the referable which is given in `KEY_TYPES_CLASSES`. |
|
|
|
:raises TypeError: If the type of the referable or any of its parent classes is not given in `KEY_TYPES_CLASSES`. |
|
""" |
The current version of the documentation can be generated by navigating to docs via cd .\sdk\docs\ and executing .\make.bat html.
Proposed Change
Update the documentation and ensure that its structure is up to date. This is also an opportunity to check for accuracy, spelling mistakes, etc.
Current Situation
The documentation hasn't been updated in a while. For example, the main structure of the documentation includes methods defined in the
__init__.pyfiles, which makes it look disorganised:basyx-python-sdk/sdk/basyx/aas/model/__init__.py
Lines 44 to 50 in ef46fd8
The current version of the documentation can be generated by navigating to docs via
cd .\sdk\docs\and executing.\make.bat html.Proposed Change
Update the documentation and ensure that its structure is up to date. This is also an opportunity to check for accuracy, spelling mistakes, etc.