Documentation for understanding logic. #6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Please add a |
|
I did not make these changes on purpose. I want on opinion from @fmrico on this first. |
Rockjack00
reviewed
Jun 26, 2025
|
|
||
| .. _is_output_modelet_concept: | ||
|
|
||
| **is_output_modelet_concept** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```phenomenon`` <phenomenon.rst>`__\ ``)`` | ||
| --------------------------------------------------------------------------------------------------------------- | ||
| **is_output_modelet_concept** ( `engine <#engine>`_ > `phenomenon <phenomenon.html>`_ ) |
There was a problem hiding this comment.
Suggested change
| **is_output_modelet_concept** ( `engine <#engine>`_ > `phenomenon <phenomenon.html>`_ ) | |
| **is_output_modelet_concept** (( `engine <#engine>`_ * `phenomenon <phenomenon.html>`_ )) > **$o** ) |
Rockjack00
reviewed
Jun 26, 2025
|
|
||
| Relations | ||
| ========= | ||
|
|
||
| .. _template_has_concept_requirement: | ||
|
|
||
| **template_has_concept_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```concept`` <concept.rst>`__\ ``)`` | ||
| -------------------------------------------------------------------------------------------------------------------- | ||
| **template_has_concept_requirement** ( `template <#template>`_ > `concept <concept.html>`_ ) |
There was a problem hiding this comment.
Suggested change
| **template_has_concept_requirement** ( `template <#template>`_ > `concept <concept.html>`_ ) | |
| **template_has_concept_requirement** ( `template <#template>`_ > `concept <concept.html>`_ ) |
Suggested change
| **template_has_concept_requirement** ( `template <#template>`_ > `concept <concept.html>`_ ) | |
| **template_has_concept_requirement** (( `template <#template>`_ * `concept <concept.html>`_ ) > **$o** ) |
Rockjack00
reviewed
Jun 26, 2025
|
|
||
| .. _template_has_location_requirement: | ||
|
|
||
| **template_has_location_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```spacetime_point`` <spacetime_point.rst>`__\ ``)`` | ||
| ------------------------------------------------------------------------------------------------------------------------------------- | ||
| **template_has_location_requirement** ( `template <#template>`_ > `spacetime_point <spacetime_point.html>`_ ) |
There was a problem hiding this comment.
Suggested change
| **template_has_location_requirement** ( `template <#template>`_ > `spacetime_point <spacetime_point.html>`_ ) | |
| **template_has_location_requirement** ( `template <#template>`_ > `spacetime_point <spacetime_point.html>`_ ) |
Suggested change
| **template_has_location_requirement** ( `template <#template>`_ > `spacetime_point <spacetime_point.html>`_ ) | |
| **template_has_location_requirement** (( `template <#template>`_ * `spacetime_point <spacetime_point.html>`_ ) > **$o** ) |
Rockjack00
reviewed
Jun 26, 2025
|
|
||
| .. _template_has_extent_requirement: | ||
|
|
||
| **template_has_extent_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```extent`` <extent.rst>`__\ ``)`` | ||
| ----------------------------------------------------------------------------------------------------------------- | ||
| **template_has_extent_requirement** ( `template <#template>`_ > `extent <extent.html>`_ ) |
There was a problem hiding this comment.
Suggested change
| **template_has_extent_requirement** ( `template <#template>`_ > `extent <extent.html>`_ ) | |
| **template_has_extent_requirement** (( `template <#template>`_ * `extent <extent.html>`_ ) > **$o** ) |
Rockjack00
reviewed
Jun 26, 2025
|
|
||
| .. include:: datatype.rst | ||
| :start-line: 8 | ||
| :end-line: 9 | ||
|
|
There was a problem hiding this comment.
Move concept to here to maintain alphabetical order.
Rockjack00
reviewed
Jun 26, 2025
Comment on lines
139
to
144
| `concept <concept.html>`_ | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| `template_set <template.rst#template_set>`__ | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| .. include:: concept.rst | ||
| :start-line: 8 | ||
| :end-line: 9 |
There was a problem hiding this comment.
move to line 33 so these are in alphabetical order.
Rockjack00
reviewed
Jun 26, 2025
| used by an `engine <engine.rst>`__. Class in the *Processing/Modelling | ||
| Model*. ###### Source: ``fundamental-concepts.tff`` | ||
| The relation a `modelet <modelet.html>`_ has with its parents, i.e. the inputs to the `engine <engine.html>`_ `exertion <exertion.html>`_. Class of their relation in the *Processing/Modelling Model*. | ||
|
|
Rockjack00
reviewed
Jun 26, 2025
|
|
||
| .. _is_property_of_m: | ||
|
|
||
| **is_property_of_modelet** ``((``\ ```property`` <#property>`__\ ``*``\ ```modelet`` <modelet.rst>`__\ ``) >``\ **``$o``**\ ``)`` | ||
| -------------------------------------------------------------------------------------------------------------------------------- | ||
| **is_property_of_modelet** (( `property <#property>`_ * `modelet <modelet.html>`_ ) > **$o** ) |
There was a problem hiding this comment.
Suggested change
| **is_property_of_modelet** (( `property <#property>`_ * `modelet <modelet.html>`_ ) > **$o** ) | |
| **modelet_has_property** (( `modelet <modelet.html>`_ * `property <#property>`_ ) > **$o** ) |
I prefer the name as is_property_of_modelet because this is a predicate. However, right now it has the name modelet_has_property and I would rather stay consistent with the code base.
Rockjack00
reviewed
Jun 26, 2025
|
|
||
| .. _is_property_of_e: | ||
|
|
||
| **is_property_of_engine** ``((``\ ```property`` <#property>`__\ ``*``\ ```engine`` <engine.rst>`__\ ``) >``\ **``$o``**\ ``)`` | ||
| ----------------------------------------------------------------------------------------------------------------------------- | ||
| **is_property_of_engine** (( `property <#property>`_ * `engine <engine.html>`_ ) > **$o** ) |
There was a problem hiding this comment.
Suggested change
| **is_property_of_engine** (( `property <#property>`_ * `engine <engine.html>`_ ) > **$o** ) | |
| **engine_has_property** (( `engine <engine.html>`_ * `property <#property>`_ ) > **$o** ) |
I prefer the name as is_property_of_engine because this is a predicate. However, right now it has the name engine_has_property and I would rather stay consistent with the code base.
Rockjack00
reviewed
Jun 26, 2025
| - `Origin <origin.rst>`__: the agent’s perspective on the *phenomenon* | ||
| - `Formalism <formalism.rst>`__: the representation of the *phenomenon* | ||
| ###### Source: ``engines-and-modelets.tff`` | ||
| Source: ``engines-and-modelets.tff`` | ||
|
|
There was a problem hiding this comment.
Please add some information here about empty_ms, and parents_of_modelet since it looks like we are going the understanding state route.
Rockjack00
suggested changes
Jun 26, 2025
Rockjack00
reviewed
Jun 27, 2025
|
|
||
| .. _modelet_has_representation_class: | ||
|
|
||
| **modelet_has_representation_class** ( `modelet <modelet.html>`_ > `representation_class <representation_class.html>`_ ) |
There was a problem hiding this comment.
Suggested change
| **modelet_has_representation_class** ( `modelet <modelet.html>`_ > `representation_class <representation_class.html>`_ ) | |
| **modelet_has_representation_class** (( `modelet <modelet.html>`_ * `representation_class <representation_class.html>`_ ) > **$o** ) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Unfortunately, reStructuredText is lacking some features of material for mkdocs, which results in worse formatting and clarity of this version compared to the original.
The addition of the 'sphinx.ext.autosummary', 'sphinx.ext.autodoc' extensions might break the build with the given package versions.
It builds for me with: