From 6f2a5c25b827c8c7c752cacd19f3d83c638fd4ba Mon Sep 17 00:00:00 2001
From: Thibaut Lunet <thibaut.lunet@tuhh.de>
Date: Sat, 14 Sep 2024 18:57:12 +0200
Subject: [PATCH] TL: fixing my bad englisch

---
 docs/devdoc/structure.md        |  4 ++--
 docs/devdoc/versionUpdate.md    |  4 ++--
 docs/notebooks/01_qCoeffs.ipynb | 10 ++++++++--
 3 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/docs/devdoc/structure.md b/docs/devdoc/structure.md
index 706f7c1..1c13723 100644
--- a/docs/devdoc/structure.md
+++ b/docs/devdoc/structure.md
@@ -156,7 +156,7 @@ class MyGenerator(QDeltaGenerator):
 ```
 
 The `computeQDelta` must simply returns the $Q_\Delta$ approximation for this generator,
-eventually using the `zeros` property as starting basis.
+potentially using the `zeros` property as starting basis.
 
 **📣 Important :** even if this may not be used by your generator, the `computeQDelta` method **must always** 
 take a `k` optional parameter corresponding to a **sweep or iteration number** in SDC or iterated RK methods, 
@@ -172,7 +172,7 @@ def computeQDelta(self, k=1):
     # TODO : returns a np.2darray with shape (self.size, self.size)
 ```
 
-> ⚠️ The `computeQDelta` method must be able to take `k=None` as argument, and eventually replace it by its default value.
+> ⚠️ The `computeQDelta` method must be able to take `k=None` as argument, and potentially replace it by its default value.
 
 You can also redefine the constructor of your generator like this :
 ```python
diff --git a/docs/devdoc/versionUpdate.md b/docs/devdoc/versionUpdate.md
index 8e82efc..d3ab140 100644
--- a/docs/devdoc/versionUpdate.md
+++ b/docs/devdoc/versionUpdate.md
@@ -13,7 +13,7 @@ Here are some generic recommendation on release-triggering events :
 
 1. patch version should be released every three months in case some only patch-type changes have been done
 2. minor version should be released after merging a PR including new features (requires a version dump commit, see below ...)
-3. major version are released when important changes have been done on a development branch named `v{i+1}-dev` hosted on the main repo. Requires a full update of the documentation and code, eventually some migration guide, etc ... Before merging `v{i+1}-dev` into `main`, a `v{i}-lts` branch is created from it to keep track of the old version, and eventually update it with some minor or patch releases until a pre-defined deprecation date defined in `docs/SECURITY.md`.
+3. major version are released when important changes have been done on a development branch named `v{i+1}-dev` hosted on the main repo. Requires a full update of the documentation and code, maybe with some migration guide, etc ... Before merging `v{i+1}-dev` into `main`, a `v{i}-lts` branch is created from it to keep track of the old version, and eventually updated with some minor or patch releases until a pre-defined deprecation date defined in `docs/SECURITY.md`.
 
 ## Pipeline description
 
@@ -23,7 +23,7 @@ To release a new version, one need maintainer access to the `qmat` Github projec
 2. Modify the version number and the release date in [`CITATION.cff`](https://github.com/Parallel-in-Time/qmat/blob/main/CITATION.cff)
 3. (Minor & major update) update [`roadmap.md`](https://github.com/Parallel-in-Time/qmat/blob/main/docs/devdoc/roadmap.md) if not done already
 4. (Major update) update [SECURITY.md](https://github.com/Parallel-in-Time/qmat/blob/main/docs/SECURITY.md) if not done already
-5. Commit with message `XX: dump version` where `XX` are your initials
+5. Commit with message `XX: bump version to x.x.x` where `XX` are your initials and `x.x.x` is the new version
 6. Manually run the ["Publish to PyPI 📦"](https://github.com/Parallel-in-Time/qmat/actions/workflows/publish.yml) workflow
 7. [Draft a new release](https://github.com/Parallel-in-Time/qmat/releases/new) associated to a new tag `v*.*.*` (with `*.*.*` the new version, and the `+ Create new tag: ... on publish` button)
 8. Find a cool title for the release, and describe what is new or changed (don't forget to thanks the non-maintainers authors)
diff --git a/docs/notebooks/01_qCoeffs.ipynb b/docs/notebooks/01_qCoeffs.ipynb
index 02ad40e..ca8e4b7 100644
--- a/docs/notebooks/01_qCoeffs.ipynb
+++ b/docs/notebooks/01_qCoeffs.ipynb
@@ -119,7 +119,7 @@
    "metadata": {},
    "source": [
     "Depending on its first given argument, `genQCoeffs` will use the associated $Q$-generator,\n",
-    "eventually passing keyword arguments to instantiate it (_e.g_ the `nNodes=4, nodeType=\"LEGENDRE\", quadType=\"RADAU-RIGHT\"` for collocation).\n",
+    "potentially passing keyword arguments to instantiate it (_e.g_ the `nNodes=4, nodeType=\"LEGENDRE\", quadType=\"RADAU-RIGHT\"` for collocation).\n",
     "If some generator arguments are missing or wrongly given, then a descriptive error is raised, for instance :"
    ]
   },
@@ -349,8 +349,14 @@
   }
  ],
  "metadata": {
+  "kernelspec": {
+   "display_name": "env",
+   "language": "python",
+   "name": "python3"
+  },
   "language_info": {
-   "name": "python"
+   "name": "python",
+   "version": "3.11.9"
   }
  },
  "nbformat": 4,