These docstrings may need a rework
This is a collection of docstrings that may need some reformulating. I am happy to provide it, though would like to discuss the content beforhand.
-
model.__init__: Update docstring -
aasmodule docstring andaas.Assetshould have a note about howAssetsare handled now -
aas.View: Resolve "Todo: What does this do exactly?" and with resolving, update docstring to be clear about what it does. -
base.Qualifiable: Unclear formulation -
base.HasExtension: Unclear explanation of attributenamespace_element_sets -
base.Referable.parent: Confusing by mentioning aReference, even though it is actually aNamespace -
base.Reference.key: Unclear formulation -
base.UnexpectedTypeError:base.Referencedoes not have a methodresolve() -
base.ValueReferencePair: Unclear formulation, does not have any reference to any other part of the meta-model -
provider.AbstractObjectProvider.get_identifiable:- Docstring says "find identifiable by id_short", parameter is of type
base.Identifierthough. - Missing docstring for ":param: identifier"
- ":raises: KeyError: Mentioning
Referablehere, while correct, may be confusing to some. Maybe useIdentifiablehere?
- Docstring says "find identifiable by id_short", parameter is of type
-
provider.AbstractObjectStore.update: Missing docstring -
submodel.OperationVariable: is in fact, not aSubmodelElement -
submodel.RelationshipElement: The mentioned subject-object relation is unclear to me. Disregard this, if this a concept I simply don't know -
Referable.display_namedescription is unclear -
base.Formula: If we don't support it anymore (in V30RC1, because formulas are not unambiguously identifiable), mention this somewhere where it makes sense -
aas.adapter.__init__: Update docstring -
adapter.json.json_deserialization: Second paragraph of module docstring seems outdated -
model.base.LangStringSet: Has no Entry in the documentation (Due to it being Dict[str, str]) and no class -
model.base.ValueList: Has not Entry in the documentation -
backend.__init__: Missing module docstring -
backend.couchdb: Missing module docstring
Edited by Sebastian Heppner