diff --git a/CHANGELOG.md b/CHANGELOG.md index a6e81ab..767d1b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,8 @@ generated in the following situations: ### 2.0.5-dev +* [TRLC, API] Fix various typos in the documentation. + * [TRLC, LRM] Allow union types as tuple field types: `tuple Ref { item [TypeA, TypeB] separator @ version Integer }` now permits a tuple field to reference objects of any of the listed record types. diff --git a/documentation/TUTORIAL-API.md b/documentation/TUTORIAL-API.md index 3b7df8e..e3ffde0 100644 --- a/documentation/TUTORIAL-API.md +++ b/documentation/TUTORIAL-API.md @@ -62,7 +62,7 @@ from trlc.trlc import Source_Manager import sys ``` -Next we need create an instance of the source manager: +Next we need to create an instance of the source manager: ```python mh = Message_Handler() @@ -88,7 +88,7 @@ them. The method parses all files, and on success returns a [Symbol_Table](https://bmw-software-engineering.github.io/trlc/manual/ast.html#trlc.ast.Symbol_Table) containing everything (types, checks, requirements, etc.). If there is -an error (used defined check or syntax error) then nothing is +an error (user defined check or syntax error) then nothing is returned. I.e. once the API lets you have the symbol table you know that everything is well formed and validated. @@ -100,7 +100,7 @@ if symbols is None: ``` Finally, lets do something simple to see what happens. Here we just -iterate overt all the objects and print them. +iterate over all the objects and print them. ```python for obj in symbols.iter_record_objects(): diff --git a/documentation/TUTORIAL-TUPLES.md b/documentation/TUTORIAL-TUPLES.md index cf7359e..898459a 100644 --- a/documentation/TUTORIAL-TUPLES.md +++ b/documentation/TUTORIAL-TUPLES.md @@ -4,7 +4,7 @@ This is part of the [TRLC Tutorial](TUTORIAL.md). ## Tuples -TRLC allows you to create used-defined algebraic datatypes, generally +TRLC allows you to create user-defined algebraic datatypes, generally referred to as "tuples". For example: ``` diff --git a/language-reference-manual/lrm.trlc b/language-reference-manual/lrm.trlc index 93517dd..fb59dae 100644 --- a/language-reference-manual/lrm.trlc +++ b/language-reference-manual/lrm.trlc @@ -227,7 +227,7 @@ section "Layout and file structure" { } Dynamic_Semantics Order_Of_Evaluation_Unordered { - text = '''After references are resolved, used-defined checks are + text = '''After references are resolved, user-defined checks are resolved on record objects. The order of record objects is unspecified.''' } diff --git a/trlc/ast.py b/trlc/ast.py index 44bc779..1e08bba 100644 --- a/trlc/ast.py +++ b/trlc/ast.py @@ -130,7 +130,7 @@ def dump(self, indent=0): # pragma: no cover This can be called for any :class:`Node` or :class:`Symbol_Table`, and can be very helpful for debugging - or understanding the parse tree. The dump methods will produce + or understanding the parse tree. The dump method will produce output like this:: Symbol_Table @@ -2717,7 +2717,7 @@ class Composite_Type(Concrete_Type, metaclass=ABCMeta): :attribute description: user-supplied description of the type or None :type: str - :attribute checks: used-defined checks for this type (excluding \ + :attribute checks: user-defined checks for this type (excluding \ inherited checks) :type: list[Check] @@ -3472,7 +3472,7 @@ def lookup_assuming(self, mh, name, required_subclass=None): """Retrieve an object from the table assuming its there This is intended for the API specifically where you want to - e.g. find some used-defined types you know are there. + e.g. find some user-defined types you know are there. :param mh: The message handler to use :type mh: Message_Handler