partial documentation finished

unibz-core · Jul 17, 2023 · 1d9f010 · 1d9f010
1 parent d3ad9ee
commit 1d9f010
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 414 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,8 @@
 
 We provide specific documentation for better explaining the Scior's scope, objectives, functioning logics, and features. Please access the following links for more information.
 
-<!-- - [Functioning Overview](https://github.com/unibz-core/Scior/blob/main/documentation/Scior-Functioning.md) -->
+- [Functioning Overview](https://github.com/unibz-core/Scior/blob/main/documentation/Scior-Functioning.md)
+<!-- - [Reports](https://github.com/unibz-core/Scior/blob/main/documentation/Scior-Reports.md) -->
 - [Execution Modes](https://github.com/unibz-core/Scior/blob/main/documentation/Scior-Execution-Modes.md)
 - [Theoretical Rules](https://github.com/unibz-core/Scior/blob/main/documentation/Scior-Theoretical-Rules.md)
 - [Implemented Rules Definitions](https://github.com/unibz-core/Scior/blob/main/documentation/Scior-Implemented-Rules-Definitions.md)

diff --git a/documentation/Scior-Functioning.md b/documentation/Scior-Functioning.md
diff --git a/documentation/Scior-Tests.md b/documentation/Scior-Tests.md
@@ -38,7 +38,7 @@ The input file (the `intput_file` test argument) is the file to be processed by
 
 Each csv line is an independent test. Each test is performed according to the flowchart below.
 
-![test flowchart](https://raw.githubusercontent.com/unibz-core/Scior/main/documentation/resources/images/Test%20Flowchart.png)
+![test flowchart](https://raw.githubusercontent.com/unibz-core/Scior/main/documentation/resources/images/flowchart_test.png)
 
 At the start, Scior receives the input owl file to be processed and the execution mode (world assumption) in which it must operate.
 

diff --git a/documentation/in progress/Scior-Reporting.docx b/documentation/in progress/Scior-Reporting.docx
diff --git a/documentation/resources/images/Rules flowchart specific.png b/documentation/resources/images/Rules flowchart specific.png
diff --git a/...ources/images/Rules flowchart general.png → ...urces/images/flowchart_rules_overview.png b/...ources/images/Rules flowchart general.png → ...urces/images/flowchart_rules_overview.png
diff --git a/documentation/resources/images/flowchart_rules_specific.png b/documentation/resources/images/flowchart_rules_specific.png
diff --git a/...ation/resources/images/Test Flowchart.png → ...ation/resources/images/flowchart_test.png b/...ation/resources/images/Test Flowchart.png → ...ation/resources/images/flowchart_test.png
diff --git a/scior/modules/rules/rules_execution.py b/scior/modules/rules/rules_execution.py
@@ -25,9 +25,7 @@
 
 def loop_rule(ontology_dataclass_list: list[OntologyDataClass], ontology_graph: Graph, list_rules_groups: list[str],
               incompleteness_stack: list[IncompletenessEntry]) -> None:
-    """ Receives a list of rule groups to perform in loop until no modifications are found.
-        AUXILIARY FUNCTION ONLY! MUST NOT BE USED OUTSIDE FUNCTION execute_rules_types.
-    """
+    """ Receives a list of rule groups to perform in loop until no modifications are found. """
 
     if args.ARGUMENTS["is_debug"]:
         loop_id = ''.join(random.choices(string.ascii_lowercase, k=4))