Fix typos and improve clarity in documentation across multiple files

grongierisc · grongierisc · commit 653a2f94d1e2 · 2025-06-30T10:45:28.000+02:00
diff --git a/docs/benchmarks.md b/docs/benchmarks.md
@@ -1,21 +1,21 @@
 # Benchmarks
 
-8 senarios with thoses parameters :
+8 scenarios with these parameters:
 - 100 messages
 - body : simple string `test`
 
 | Scenario | Time (s) |
 | --- | --- |
 | Python BP to Python BO with Iris Message | 0.239 |
 | Python BP to Python BO with Python Message | 0.232 |
-| ObjetScript BP to Python BO with Iris Message | 0.294 |
-| ObjetScript BP to Python BO with Python Message | 0.242 |
-| Python BP to ObjetScript BO with Iris Message | 0.242 |
-| Python BP to ObjetScript BO with Python Message | 0.275 |
-| ObjetScript BP to ObjetScript BO with Iris Message | 0.159 |
-| ObjetScript BP to ObjetScript BO with Python Message | 0.182 |
+| ObjectScript BP to Python BO with Iris Message | 0.294 |
+| ObjectScript BP to Python BO with Python Message | 0.242 |
+| Python BP to ObjectScript BO with Iris Message | 0.242 |
+| Python BP to ObjectScript BO with Python Message | 0.275 |
+| ObjectScript BP to ObjectScript BO with Iris Message | 0.159 |
+| ObjectScript BP to ObjectScript BO with Python Message | 0.182 |
 
-Benchmarked can be run in the unit test with the following command :
+Benchmarks can be run in the unit test with the following command :
 
 ```bash
 pytest src/tests/test_bench.py
diff --git a/docs/command-line.md b/docs/command-line.md
@@ -83,9 +83,9 @@ With an argument, it set the default production.
 iop -d IoP.Production
 ```
 
-## lists
+## list
 
-The lists command list productions.
+The list command lists productions.
 
 ```bash
 iop -l
diff --git a/docs/component-interaction.md b/docs/component-interaction.md
@@ -7,7 +7,7 @@ This is the IRIS Framework.
 The components inside of IRIS represent a production. 
 
 You have 3 main components:
-- **BusinessService**: This component aims to recieve requests from external applications.
+- **BusinessService**: This component aims to receive requests from external applications.
 - **BusinessProcess**: This component is responsible for processing the requests and orchestrating the business logic.
 - **BusinessOperation**: This component is responsible for executing the technical operations that are needed to fulfill the requests.
 
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -36,7 +36,7 @@ Here you can choose between:
 
 ##### Set up the IRIS instance.
 
-Then, symbolically this git to the IRIS pyhton directory:
+Then, symbolically link this git repository to the IRIS python directory:
 
 ```bash
 ln -s <your_git_dir>/src/iop $IRISINSTALLDIR/python/iop
diff --git a/docs/debug.md b/docs/debug.md
@@ -4,7 +4,7 @@ How to debug IoP code.
 
 Before anything, I will put some context about IoP and IRIS.
 
-Next I will show how to debug the code.
+Next, I will show how to debug the code.
 
 Finally, we will give some tips about debugging.
 
@@ -20,7 +20,7 @@ That means the python code is not running by a python interpreter, but by an IRI
 
 ## Remote Debugging
 
-To remote debbug your code, you need IoP version 3.4.1 or later.
+To remote debug your code, you need IoP version 3.4.1 or later.
 
 You will then have access to new options in the management portal.
 
@@ -212,7 +212,7 @@ Since iop version 3.4.3, you can use the `%traceback` setting to enable or disab
 
 This can help you to see the stack trace of the error and understand what is happening in the code.
 
-With traebacks enabled: 
+With tracebacks enabled: 
 
 ![Traceback enabled](./img/traceback_enable.png)
 
diff --git a/docs/dtl.md b/docs/dtl.md
@@ -2,7 +2,7 @@
 
 Starting with version 3.2.0, IoP supports DTL transformations.
 
-DTL the Data Transformation Layer in IRIS Interoperability. 
+DTL is the Data Transformation Layer in IRIS Interoperability. 
 
 DTL transformations are used to transform data from one format to another with a graphical editor.
 It supports also `jsonschema` structures.
@@ -63,7 +63,7 @@ Then select the source and target message classes.
 
 ![DTL Transformation](./img/dtl_wizard.png)
 
-And it's schema.
+And its schema.
 
 ![DTL Transformation](./img/vdoc_type.png)
 
@@ -97,7 +97,7 @@ Starting with version 3.2.0, IoP supports `jsonschema` structures for DTL transf
 
 Same as for message classes, you need to register your `jsonschema`.
 
-To do so, you need to invoke his iris command:
+To do so, you need to invoke this IRIS command:
 
 ```objectscript
 zw ##class(IOP.Message.JSONSchema).ImportFromFile("/irisdev/app/random_jsonschema.json","Demo","Demo")
diff --git a/docs/example.md b/docs/example.md
@@ -47,7 +47,7 @@ class MyResponse(Message):
 
 To register a component, create a `setting.py` file in the root of your project. This file will be used to register your classes and productions.
 
-### Example of `setting.py`
+### Example of `settings.py`
 
 ```python
 import bo
@@ -62,7 +62,7 @@ CLASSES = {
 Use the `iop` command line to register your component:
 
 ```bash
-iop --migrate /path/to/your/project/setting.py
+iop --migrate /path/to/your/project/settings.py
 ```
 
 ## Business Service
@@ -188,7 +188,7 @@ class MyAsyncNGBP(BusinessProcess):
 To make an async call with the native `send_request_async` method, use the following code:
 
 ```python
-from grongier.pex import BusinessProcess
+from iop import BusinessProcess
 from msg import MyMessage
 
 
diff --git a/docs/getting-started/first-steps.md b/docs/getting-started/first-steps.md
@@ -122,7 +122,7 @@ PRODUCTIONS = [
     ]
 ```
 
-In this file, we import our `MyBo` class named in iris `MyIRIS.MyBo`, and we add it to the `CLASSES` dictionnary.
+In this file, we import our `MyBo` class named in iris `MyIRIS.MyBo`, and we add it to the `CLASSES` dictionary.
 
 Then, we add a new production to the `PRODUCTIONS` list. This production will contain our `MyBo` class instance named `Instance.Of.MyBo`.
 
diff --git a/docs/getting-started/register-component.md b/docs/getting-started/register-component.md
@@ -28,7 +28,7 @@ CLASSES = {
 Use the `iop` command line to register your component:
 
 ```bash
-iop --migrate /path/to/your/project/setting.py
+iop --migrate /path/to/your/project/settings.py
 ```
 
 ## Using the Python Shell
diff --git a/docs/prod-settings.md b/docs/prod-settings.md
@@ -68,25 +68,25 @@ To create a custom settings, you create an attribute in your class.
 
 This attribute must :
 
-- have an default value. 
-- don't start with an underscore.
+- have a default value. 
+- not start with an underscore.
 - be untyped or have the following types: `str`, `int`, `float`, `bool`.
 
-Otherwise, it will not be available in the managment portal.
+Otherwise, it will not be available in the management portal.
 
 ```python
 from iop import BusinessOperation
 
 class MyBusinessOperation(BusinessOperation):
 
-    # This setting will be available in the managment portal
+    # This setting will be available in the management portal
     foo: str = "default"
     my_number: int = 42
     untyped_setting = None
 
-    # This setting will not be available in the managment portal
+    # This setting will not be available in the management portal
     _my_internal_setting: str = "default"
-    no_aviable_setting
+    # no_available_setting  # This line would cause a syntax error
     
     def on_init(self):
         self.log_info("[Python] MyBusinessOperation:on_init() is called")
@@ -95,8 +95,8 @@ class MyBusinessOperation(BusinessOperation):
         return
 ```
 
-They will be available in the managment portal as the following:
+They will be available in the management portal as the following:
 
 ![Custom settings](img/custom_settings.png)
 
-If you overwrite the default value in the managment portal, the new value will be passed to your class.
+If you overwrite the default value in the management portal, the new value will be passed to your class.
diff --git a/docs/venv.md b/docs/venv.md
@@ -6,11 +6,11 @@ How to set up a virtual environment for the Iris IOP framework.
 
 >! Note: This is a proof-of-concept and not a production-ready solution.
 
-As it's a proof-of-concept, a toggle is available and called `%Venv` if you want to enable or disable the virtual environment support.
+As this is a proof-of-concept, a toggle is available and called `%Venv` if you want to enable or disable the virtual environment support.
 
 ## How everything is set up
 
-The source code are migrated to iris thanks to the `iop --migrate` command.
+The source code is migrated to IRIS thanks to the `iop --migrate` command.
 
 Both virtual environments are created using the vanilla `python -m venv` command.
 
@@ -54,22 +54,22 @@ See the full example in the [iris-venv-demo](https://github.com/grongierisc/iris
 
 ### How it works
 
-As the interoperability framework works with independent processes, it's manageable to run each process in its own virtual environment.
+As the interoperability framework works with independent processes, it is manageable to run each process in its own virtual environment.
 
 This allows for easy management of dependencies and versions.
 
 For this demo, we will be using two virtual environments:
 
 - `.venv` 
     - This is the main virtual environment that will run source code in `./src/python/reddit`
-    - It will use it's own dependencies in `./src/python/reddit/requirements.txt`
+    - It will use its own dependencies in `./src/python/reddit/requirements.txt`
         - `requests`
         - `dataclasses-json`
     - The version of python will be `3.12`
     - The venv folder will be in `/opt/irisapp/.venv/`
 - `.venv3.11`
     - This is a secondary virtual environment that will run source code in `./src/python/other`
-    - It will use it's own dependencies in `./src/python/other/requirements.txt`
+    - It will use its own dependencies in `./src/python/other/requirements.txt`
         - `deepdiff`
     - The version of python will be `3.11`
     - The venv folder will be in `/opt/irisapp/.venv3.11/`

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ PRODUCTIONS = [`
`122`	`122`	`]`
`123`	`123`	```
`124`	`124`
`125`		-In this file, we import our `MyBo` class named in iris `MyIRIS.MyBo`, and we add it to the `CLASSES` dictionnary.
	`125`	+In this file, we import our `MyBo` class named in iris `MyIRIS.MyBo`, and we add it to the `CLASSES` dictionary.
`126`	`126`
`127`	`127`	Then, we add a new production to the `PRODUCTIONS` list. This production will contain our `MyBo` class instance named `Instance.Of.MyBo`.
`128`	`128`