Update text formatting #21

docs/development/continuous-integration/setup_github_actions.md

@@ -2,7 +2,8 @@
 
 ## What is included in the tests?
 
-Our continuous integration (CI) process executes a series of tests, including running `pytest` and performing linting and code quality checks.
+Our continuous integration (CI) process executes a series of tests, including
+running `pytest` and performing linting and code quality checks.
 
 Here's an overview of the tasks involved in our example:
 
@@ -11,9 +12,13 @@ Here's an overview of the tasks involved in our example:
 - Verifying `docstrings` with `flake8`
 - Sorting imports with `isort`
 
-All these tools are executed as part of a job defined within a GitHub Actions workflow file. The workflow defines the tasks for a job, and a runner executes these tasks on a virtual machine provided by GitHub.
+All these tools are executed as part of a job defined within a GitHub Actions workflow file.
+The workflow defines the tasks for a job, and a runner executes these tasks on a
+virtual machine provided by GitHub.
 
 !!! Info "Setup GitHub Actions"
     To set up GitHub Actions workflows for your repository, follow the [official GitHub guide](https://docs.github.com/en/actions/guides).
 
-Our CI workflow is triggered whenever there's a pull request or a commit to the `develop` or `production` branches. The workflow prepares the Python environment and installs relevant dependencies before executing the `tox` automation suite. If any errors are detected, the workflow fails and generates a detailed report for developers to review.
+Our CI workflow is triggered whenever there's a pull request or a commit to the `develop` or `production` branches.
+The workflow prepares the Python environment and installs relevant dependencies before executing the `tox` automation suite.
+If any errors are detected, the workflow fails and generates a detailed report for developers to review.

docs/development/continuous-integration/setup_tox.md

@@ -1,9 +1,15 @@
 # Configure Tox test-automation
 
-To streamline our test environment setup, we use `tox`, a powerful tool that automates testing across different environments.
+To streamline our test environment setup, we use `tox`, a powerful tool that
+automates testing across different environments.
 
 !!! Note
-    [Tox](https://tox.wiki/en/stable/) is a powerful tool that simplifies and automates the process of testing Python projects across different environments. It ensures that your code is reliable, functional, and compatible with various Python versions and dependencies, ultimately leading to higher code quality and more robust software. Combined with a runner like GitHub Actions, it allows you to automate a wide range of tasks.
+    [Tox](https://tox.wiki/en/stable/) is a powerful tool that simplifies
+    and automates the process of testing Python projects across different environments.
+    It ensures that your code is reliable, functional, and compatible with various
+    Python versions and dependencies, ultimately leading to higher code quality
+    and more robust software. Combined with a runner like GitHub Actions,
+    it allows you to automate a wide range of tasks.
 
     ??? Info "Key features and functionalities"
 
@@ -50,7 +56,10 @@ pip install tox
 
 ## Setup
 
-Configuring `tox` may involve some complexity. Start by defining what tests you want to run and what dependencies (such as packages or external services) are required for the tests. Organize these test tasks into logical steps.
+Configuring `tox` may involve some complexity.
+Start by defining what tests you want to run and what dependencies
+(such as packages or external services) are required for the tests.
+Organize these test tasks into logical steps.
 
 !!! Info "Tox User Guide"
     The official [tox User Guide](https://tox.wiki/en/stable/user_guide.html)

docs/development/continuous-integration/usage.md

@@ -1,11 +1,13 @@
-# Usage 
+# Usage
 
 ## Add new code test
 
-To add a new test for any new functionality you have added or you plan to add you should add a test. The test is imply added to the tests/ 
-directory. 
+To add a new test for any new functionality you have added or you plan to add you should add a test.
+The test is imply added to the tests/
+directory.
 
 See our examples ....
+
 ## Debugging
 
 ### Local Debugging
@@ -25,4 +27,4 @@ For remote debugging, you can monitor the status of your automation jobs in two
 1. Create a pull request and view the CI status integration there.
 2. Visit the [Actions tab of your repository](https://github.com/rl-institut/super-repo/actions) to see all available job executions.
 
-These options allow you to closely monitor the progress and outcomes of your CI workflow, ensuring the reliability and quality of your codebase.
+These options allow you to closely monitor the progress and outcomes of your CI workflow, ensuring the reliability and quality of your codebase.