Documentation for understanding logic. #6

alex-quin-gabriel · 2025-05-06T20:56:15Z

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:

breathe-4.36.0
docutils-0.21.2
jinja2-3.1.6
sphinx-8.2.3
sphinx_rtd_theme-3.0.2

Rockjack00 · 2025-06-26T07:33:46Z

Please add a requirements.txt file or update the readme to include the new dependencies.

alex-quin-gabriel · 2025-06-26T07:57:24Z

I did not make these changes on purpose. I want on opinion from @fmrico on this first.

Rockjack00 · 2025-06-26T17:24:03Z

understanding-logic/concepts/engine.rst


-**is_output_modelet_concept** ``(``\ ```engine`` <#engine>`__\ ``>``\ ```phenomenon`` <phenomenon.rst>`__\ ``)``
---------------------------------------------------------------------------------------------------------------
+**is_output_modelet_concept** ( `engine <#engine>`_ > `phenomenon <phenomenon.html>`_ )


Suggested change

**is_output_modelet_concept** ( `engine <#engine>`_ > `phenomenon <phenomenon.html>`_ )

**is_output_modelet_concept** (( `engine <#engine>`_ * `phenomenon <phenomenon.html>`_ )) > **$o** )

Rockjack00 · 2025-06-26T17:45:13Z

understanding-logic/concepts/template.rst


-**template_has_concept_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```concept`` <concept.rst>`__\ ``)``
--------------------------------------------------------------------------------------------------------------------
+**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>`_ )

Suggested change

**template_has_concept_requirement** ( `template <#template>`_ > `concept <concept.html>`_ )

**template_has_concept_requirement** (( `template <#template>`_ * `concept <concept.html>`_ ) > **$o** )

Rockjack00 · 2025-06-26T17:46:10Z

understanding-logic/concepts/template.rst


-**template_has_location_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```spacetime_point`` <spacetime_point.rst>`__\ ``)``
-------------------------------------------------------------------------------------------------------------------------------------
+**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>`_ )

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 · 2025-06-26T17:47:26Z

understanding-logic/concepts/template.rst


-**template_has_extent_requirement** ``(``\ ```template`` <#template>`__\ ``>``\ ```extent`` <extent.rst>`__\ ``)``
-----------------------------------------------------------------------------------------------------------------
+**template_has_extent_requirement** ( `template <#template>`_ > `extent <extent.html>`_ )


Suggested change

**template_has_extent_requirement** ( `template <#template>`_ > `extent <extent.html>`_ )

**template_has_extent_requirement** (( `template <#template>`_ * `extent <extent.html>`_ ) > **$o** )

Rockjack00 · 2025-06-26T18:08:49Z

understanding-logic/concepts/index.rst

+.. include:: datatype.rst
+   :start-line: 8
+   :end-line: 9



Move concept to here to maintain alphabetical order.

Rockjack00 · 2025-06-26T18:09:37Z

understanding-logic/concepts/index.rst

+`concept <concept.html>`_
+~~~~~~~~~~~~~~~~~~~~~~~~~

-`template_set <template.rst#template_set>`__
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. include:: concept.rst
+   :start-line: 8
+   :end-line: 9


move to line 33 so these are in alphabetical order.

Rockjack00 · 2025-06-26T18:19:49Z

understanding-logic/concepts/representation_class.rst

-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*.
+


I did like the old description which talks about the extrinsic/intrinsic purpose

The purpose of a modelet (extrinsic to itself) when used by an engine. Class in the Processing/Modelling Model.

Rockjack00 · 2025-06-26T19:50:33Z

understanding-logic/concepts/property.rst


-**is_property_of_modelet** ``((``\ ```property`` <#property>`__\ ``*``\ ```modelet`` <modelet.rst>`__\ ``) >``\ **``$o``**\ ``)``
--------------------------------------------------------------------------------------------------------------------------------
+**is_property_of_modelet** (( `property <#property>`_ * `modelet <modelet.html>`_ ) > **$o** )


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 · 2025-06-26T19:51:13Z

understanding-logic/concepts/property.rst


-**is_property_of_engine** ``((``\ ```property`` <#property>`__\ ``*``\ ```engine`` <engine.rst>`__\ ``) >``\ **``$o``**\ ``)``
-----------------------------------------------------------------------------------------------------------------------------
+**is_property_of_engine** (( `property <#property>`_ * `engine <engine.html>`_ ) > **$o** )


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 · 2025-06-26T21:14:10Z

understanding-logic/concepts/modelet.rst

-  `Formalism <formalism.rst>`__: the representation of the *phenomenon*
-   ###### Source: ``engines-and-modelets.tff``
+Source: ``engines-and-modelets.tff``



Please add some information here about empty_ms, and parents_of_modelet since it looks like we are going the understanding state route.

Rockjack00

I have added several notes today on the documentation while modeling the decision system. Apologies they all ended up in separate comments :o

Rockjack00 · 2025-06-27T08:12:11Z

understanding-logic/concepts/modelet.rst

+
+.. _modelet_has_representation_class:
+
+**modelet_has_representation_class** ( `modelet <modelet.html>`_ > `representation_class <representation_class.html>`_ )


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** )

fmrico · 2025-10-08T09:40:58Z

Is this PR abandoned?

Rockjack00 · 2025-10-16T11:43:32Z

Probably, there have been some major changes since. @alex-quin-gabriel is the authority.

alex-quin-gabriel added 2 commits May 6, 2025 17:50

adding understanding-logic documentation

102f972

adding understanding logic documentation

4d7a38a

alex-quin-gabriel mentioned this pull request May 7, 2025

Make the documentation available online CoreSenseEU/understanding-logic#9

Open

Rockjack00 reviewed Jun 26, 2025

View reviewed changes

Rockjack00 suggested changes Jun 26, 2025

View reviewed changes

Rockjack00 reviewed Jun 27, 2025

View reviewed changes

	is_output_modelet_concept ( `engine <#engine>`_ > `phenomenon <phenomenon.html>`_ )
	is_output_modelet_concept (( `engine <#engine>`_ * `phenomenon <phenomenon.html>`_ )) > $o )

	template_has_concept_requirement ( `template <#template>`_ > `concept <concept.html>`_ )
	template_has_concept_requirement ( `template <#template>`_ > `concept <concept.html>`_ )

	template_has_concept_requirement ( `template <#template>`_ > `concept <concept.html>`_ )
	template_has_concept_requirement (( `template <#template>`_ * `concept <concept.html>`_ ) > $o )

	template_has_location_requirement ( `template <#template>`_ > `spacetime_point <spacetime_point.html>`_ )
	template_has_location_requirement ( `template <#template>`_ > `spacetime_point <spacetime_point.html>`_ )

	template_has_location_requirement ( `template <#template>`_ > `spacetime_point <spacetime_point.html>`_ )
	template_has_location_requirement (( `template <#template>`_ * `spacetime_point <spacetime_point.html>`_ ) > $o )

	template_has_extent_requirement ( `template <#template>`_ > `extent <extent.html>`_ )
	template_has_extent_requirement (( `template <#template>`_ * `extent <extent.html>`_ ) > $o )

	is_property_of_modelet (( `property <#property>`_ * `modelet <modelet.html>`_ ) > $o )
	modelet_has_property (( `modelet <modelet.html>`_ * `property <#property>`_ ) > $o )

	is_property_of_engine (( `property <#property>`_ * `engine <engine.html>`_ ) > $o )
	engine_has_property (( `engine <engine.html>`_ * `property <#property>`_ ) > $o )


		.. _modelet_has_representation_class:

		modelet_has_representation_class ( `modelet <modelet.html>`_ > `representation_class <representation_class.html>`_ )

	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 )

Documentation for understanding logic. #6

Are you sure you want to change the base?

Documentation for understanding logic. #6

Uh oh!

Conversation

alex-quin-gabriel commented May 6, 2025

Uh oh!

Rockjack00 commented Jun 26, 2025

Uh oh!

alex-quin-gabriel commented Jun 26, 2025

Uh oh!

Rockjack00 Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rockjack00 Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rockjack00 Jun 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rockjack00 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fmrico commented Oct 8, 2025

Uh oh!

Rockjack00 commented Oct 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Rockjack00 Jun 26, 2025 •

edited

Loading

Rockjack00 Jun 26, 2025 •

edited

Loading

Rockjack00 Jun 26, 2025 •

edited

Loading

Rockjack00 left a comment •

edited

Loading