PyI40AAS issueshttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues2021-04-12T11:47:43+02:00https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/136Update project structure in README.md2021-04-12T11:47:43+02:00Igor GarmaevUpdate project structure in README.mdAdd submodul `aas.backends` and his description to `Project Structure` part in README.MDAdd submodul `aas.backends` and his description to `Project Structure` part in README.MDhttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/115These docstrings may need a rework2021-02-25T11:11:48+01:00Sebastian Heppners.heppner@iat.rwth-aachen.deThese docstrings may need a reworkThis is a collection of docstrings that may need some reformulating. I am happy to provide it, though would like to discuss the content beforhand.
* [x] `model.__init__`: Update docstring
* [x] `aas` module docstring and `aas.Asset` sho...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.
* [x] `model.__init__`: Update docstring
* [x] `aas` module docstring and `aas.Asset` should have a note about how `Assets` are handled now
* [x] `aas.View`: Resolve "Todo: What does this do exactly?" and with resolving, update docstring to be clear about what it does.
* [x] `base.Qualifiable`: Unclear formulation
* [x] `base.HasExtension`: Unclear explanation of attribute `namespace_element_sets`
* [x] `base.Referable.parent`: Confusing by mentioning a `Reference`, even though it is actually a `Namespace`
* [x] `base.Reference.key`: Unclear formulation
* [x] `base.UnexpectedTypeError`: `base.Reference` does not have a method `resolve()`
* [x] `base.ValueReferencePair`: Unclear formulation, does not have any reference to any other part of the meta-model
* [x] `provider.AbstractObjectProvider.get_identifiable`:
* Docstring says "find identifiable by id_short", parameter is of type `base.Identifier` though.
* Missing docstring for ":param: identifier"
* ":raises: KeyError: Mentioning `Referable` here, while correct, may be confusing to some. Maybe use `Identifiable` here?
* [x] `provider.AbstractObjectStore.update`: Missing docstring
* [x] `submodel.OperationVariable`: is in fact, not a `SubmodelElement`
* [x] `submodel.RelationshipElement`: The mentioned subject-object relation is unclear to me. Disregard this, if this a concept I simply don't know
* [x] `Referable.display_name` description is unclear
* [x] `base.Formula`: If we don't support it anymore (in V30RC1, because formulas are not unambiguously identifiable), mention this somewhere where it makes sense
* [x] `aas.adapter.__init__`: Update docstring
* [x] `adapter.json.json_deserialization`: Second paragraph of module docstring seems outdated
* [x] `model.base.LangStringSet`: Has no Entry in the documentation (Due to it being Dict[str, str]) and no class
* [x] `model.base.ValueList`: Has not Entry in the documentation
* [x] `backend.__init__`: Missing module docstring
* [x] `backend.couchdb`: Missing module docstringSebastian Heppners.heppner@iat.rwth-aachen.deSebastian Heppners.heppner@iat.rwth-aachen.dehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/70readme: Explain how to use compliance tool2020-05-19T12:33:45+02:00Michael Thiesreadme: Explain how to use compliance tool* We could just refer to the `--help` command
* If there's more to explain, we should probably create a new `README.md` file in `aas/compliance_tool/` and link to it* We could just refer to the `--help` command
* If there's more to explain, we should probably create a new `README.md` file in `aas/compliance_tool/` and link to itAlpha Release 0.1.0https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/69examples: Add tutorial for writing and reading AASX packages2021-02-10T17:46:34+01:00Michael Thiesexamples: Add tutorial for writing and reading AASX packageshttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/62model.aas: Update module docstring2020-04-21T09:37:34+02:00Sebastian Heppners.heppner@iat.rwth-aachen.demodel.aas: Update module docstringConceptDictionary, ConceptDescription etc. is now located in `model.concept`.ConceptDictionary, ConceptDescription etc. is now located in `model.concept`.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/61adapter._generic: Missing module docstring2020-04-21T09:37:35+02:00Sebastian Heppners.heppner@iat.rwth-aachen.deadapter._generic: Missing module docstringhttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/59doc: Create reference manual / API documentation2021-08-12T13:32:46+02:00Michael Thiesdoc: Create reference manual / API documentationWe could provide a Sphinx-generated documentation, describing how to each module's features in detail (including auto-generated function signatures/descriptions).We could provide a Sphinx-generated documentation, describing how to each module's features in detail (including auto-generated function signatures/descriptions).Sebastian Heppners.heppner@iat.rwth-aachen.deSebastian Heppners.heppner@iat.rwth-aachen.dehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/58doc: Expand README.md2020-04-15T16:47:13+02:00Michael Thiesdoc: Expand README.mdThe readme file should include the following sections:
* Features – list-style but comprehensible description of the provided features of this project
* Getting started –
* Example – Short code block (~25 loc) demonstrating the main ...The readme file should include the following sections:
* Features – list-style but comprehensible description of the provided features of this project
* Getting started –
* Example – Short code block (~25 loc) demonstrating the main features of the framework. May be part of the *Getting Started* (no individual heading)
* References to further resources (examples)
* Project Structure – Short overview over the included packages and modules (only those wihtin the `aas` package). This may be merged somehow with the *Features* section
* Contributing
* Information about our codestyle and testing
* Information about how to contribute Code/patchesSebastian Heppners.heppner@iat.rwth-aachen.deSebastian Heppners.heppner@iat.rwth-aachen.dehttps://git.rwth-aachen.de/acplt/pyi40aas/-/issues/24Add package and module docstrings explaining what is contained in each packag...2019-12-20T15:12:45+01:00Michael ThiesAdd 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 funct...* 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` and the `aas.model` package 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 `aas` might be overlapping with the README.md file, which should also explain the project structure.https://git.rwth-aachen.de/acplt/pyi40aas/-/issues/15add license2019-12-11T11:19:39+01:00Leon Mauritz Mölleradd license