Commit: 5f1b122c9ce7e2bd0d1c5de272477a26f9f4c24d - DocIdeas (hg)

Commit MetaInfo

• Revision: 5f1b122c9ce7e2bd0d1c5de272477a26f9f4c24d (tree)
• Time: 2022-10-24 05:47:01
• Author: Albert Mietus < albert AT mietus DOT nl >
• Commiter: Albert Mietus < albert AT mietus DOT nl >

Log Message

asis

Change Summary

• modified: CCastle/1.Usage/9.WorkshopTools.rst
• modified: CCastle/short/pegen_parser.rst

Incremental Difference

diff -r 55d41160fc9f -r 5f1b122c9ce7 CCastle/1.Usage/9.WorkshopTools.rst
--- a/CCastle/1.Usage/9.WorkshopTools.rst	Sun Oct 23 22:34:10 2022 +0200
+++ b/CCastle/1.Usage/9.WorkshopTools.rst	Sun Oct 23 22:47:01 2022 +0200
@@ -7,7 +7,7 @@
 ==============
 
 
-.. post:: 
+.. post::
    :category: Castle, Usage,
    :tags: Castle, Tools, DRAFT
 
@@ -18,8 +18,7 @@
    Probably you have many questions about the software. About its `metrics
    <https://en.wikipedia.org/wiki/Software_metric>`__: like the `Fan-Out
    <https://en.wikipedia.org/wiki/Fan-out_(software)>`__ of a given class or its `Cyclomatic-Complexity
-   <https://en.wikipedia.org/wiki/Cyclomatic_complexity>`__. Or merely like to know which components are connected.
-   |BR|
+   <https://en.wikipedia.org/wiki/Cyclomatic_complexity>`__. Or merely like to k
    Often this isn’t too complicated. But the amount of error-prone work is dramatic. Castle comes with tools that
    provide the answer.
 
@@ -27,19 +26,59 @@
 Classic tools are not sufficient
 ================================
 
-Most languages come with a compiler_ and optional a debugger_. The compiler_ (and its companions: linker, loader)
+Most languages come with a compiler_ and, optional a debugger_. The compiler_ (and its companions: linker, loader)
 translate files with source code into *computer code*; often called the “binaries”. Nowadays, an “optimiser_” is usually
 build-in to unburden the developer from details that make the code more efficient. So that (s)he can make code readable
-and maintainable.  For example, by employing extra local, well-named variables that do not result in more memory use;
-the use of convenient loops, which are unrolled automatically, etc.  Originally, the intent was to optimise binaries;
-but they help to improve the source for developers too.
+and maintainable.  For example, by defining extra, well-named variables that do not result in more memory use;
+the use of convenient loops, which are unrolled automatically, etc.
 |BR|
+Originally, the intent was to optimise binaries; but they help to improve the source for developers too.
+
 The second well-known tool is the “source-level debugger_\”. It understands the binary and can correlate that with the
-source code -- which isn’t trivial, especially not due to the optimiser_. It is an awesome tool when there is a bug in
+source code -- which isn’t trivial, especially due to the optimiser_. It is an awesome tool when there is a bug in
 the code; as the developer can step “line by line” through the source code, examine in-between results, and even change
-some parameters on the fly. Once this was the only way to improve code. In the present day, we have other instruments
-too; like Test-Driven-Development to prevent the nastiest flows in the first place.
+some parameters on the fly.
+|BR|
+Once this was the only way to improve code. In the present day, we have other instruments too; like
+Test-Driven-Development to prevent the nastiest flows in the first place.
 
+|BR|
+-----
+
+TODO
+====
+
+* Explore
+
+  - Simulate
+
+    - https://dezyne.org/dezyne/manual/dezyne/html_node/Invoking-dzn-simulate.html
+
+  - Vizualize (show)
+
+
+* Verification & Validation (https://en.wikipedia.org/wiki/Software_verification_and_validation)
+
+  - https://dezyne.org/dezyne/manual/dezyne/html_node/Invoking-dzn-verify.html
+
+* Trace, Debug, Log/Monitor
+
+* Query/Metrics  (https://en.wikipedia.org/wiki/Software_metric)
+
+  - Cyclomatic_complexity  https://en.wikipedia.org/wiki/Cyclomatic_complexity
+
+  - ? Fan-In/Out https://en.wikipedia.org/wiki/Fan-out_(software), UncleBob
+
+
+
+
+
+----------
+
+.. rubric:: Footnotes
+
+.. [#XXXX]
+   XXXX
 
 .. _Software_metric:		https://en.wikipedia.org/wiki/Software_metric
 .. _Fan-Out:			https://en.wikipedia.org/wiki/Fan-out_(software)

diff -r 55d41160fc9f -r 5f1b122c9ce7 CCastle/short/pegen_parser.rst
--- a/CCastle/short/pegen_parser.rst	Sun Oct 23 22:34:10 2022 +0200
+++ b/CCastle/short/pegen_parser.rst	Sun Oct 23 22:47:01 2022 +0200
@@ -32,9 +32,9 @@
 The lexer will recognize some tokes that are specialy for python, like `INDENT` & `DEDENT`. Also some generic tokens
 like NAME (which is an ID) and `NUMBER` are know, and can be used to define the language.
 
-Unfortunally, it will also find some tokens --typical operators-- that *hardcoded* for python. By we like to use
-differently. Possible combined with other characters. Then, those will not be found; not the literal-strings as set in
-the grammar.
+Unfortunally, it will also find some tokens --typical operators-- that *hardcoded* for python. Even when we like to use
+them differently; possible combined with other characters. Then, those will not be found; not the literal-strings as set
+in the grammar.
 
 .. warning::
 
@@ -43,13 +43,13 @@
       Left_arrow_BAD: '<-'	## This is WRONG, as ``<`` is sees as a token
       Left_arrow_OKE: '<' '-'	## This is acceptable
 
-.. seealso:: https://docs.python.org/3/library/token.html
-             
+.. seealso:: https://docs.python.org/3/library/token.html for an overiew of the predefied tokens
+
 .. tip::
 
-   A quick trick to see how a file is split in tokens, use ``python -m tokenize [-e] filename.peg``.
+   A quick trick to see how a file is split into tokens, use ``python -m tokenize [-e] filename.peg``.
    |BR|
-   And make sure you do not use string-literals that (eg) are composed of two tokens.
+   Make sure you do not use string-literals that (eg) are composed of two tokens.