From 8a7d6b6f63d4c24b0f7d133eab000ac1a23f06dd Mon Sep 17 00:00:00 2001
From: Jonathan Giffard <39745127+LackOfMorals@users.noreply.github.com>
Date: Mon, 29 Jan 2024 14:15:55 +0000
Subject: [PATCH 1/3] Fix typos in developer-guide.adoc
Corrected a number of typos in the developer-guide.adoc pages
---
docs/modules/ROOT/pages/developer-guide.adoc | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/modules/ROOT/pages/developer-guide.adoc b/docs/modules/ROOT/pages/developer-guide.adoc
index 5131abe..ab43d9f 100644
--- a/docs/modules/ROOT/pages/developer-guide.adoc
+++ b/docs/modules/ROOT/pages/developer-guide.adoc
@@ -1,4 +1,4 @@
-= Developmer Guide
+= Developer Guide
To install the CLI for development, do the following:
@@ -10,7 +10,7 @@ to activate the virtual environment.
Next, run:
----
-pip install --editable .
+pip install --editable
----
to install the dependencies. Then you can run the CLI:
----
@@ -21,7 +21,7 @@ When finished, run:
----
deactivate
----
-to deactivate the venv.
+to deactivate the Python virtual environment
For development, you will need the following Python libraries installed:
@@ -34,9 +34,9 @@ For development, you will need the following Python libraries installed:
== Testing
-The CLI uses *pytest* for unit testing and a Python script for realese checks.
+The CLI uses *pytest* for unit testing and a Python script for release checks.
To run the unit tests, run:
----
pytest tests/unit
-----
\ No newline at end of file
+----
From 9e8eb6b9cc93557c1a6ca63f3321304da14fb319 Mon Sep 17 00:00:00 2001
From: Jonathan Giffard <39745127+LackOfMorals@users.noreply.github.com>
Date: Wed, 14 Feb 2024 11:18:51 +0000
Subject: [PATCH 2/3] Address comment from Daniel
Reverted to put back the full stop as per the comment from Daniel.
---
docs/modules/ROOT/pages/developer-guide.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/modules/ROOT/pages/developer-guide.adoc b/docs/modules/ROOT/pages/developer-guide.adoc
index ab43d9f..e90ce54 100644
--- a/docs/modules/ROOT/pages/developer-guide.adoc
+++ b/docs/modules/ROOT/pages/developer-guide.adoc
@@ -10,7 +10,7 @@ to activate the virtual environment.
Next, run:
----
-pip install --editable
+pip install --editable .
----
to install the dependencies. Then you can run the CLI:
----
From f4f1f6b98e33b3b21b8c9c0048522199b27e33a3 Mon Sep 17 00:00:00 2001
From: Jonathan Giffard <39745127+LackOfMorals@users.noreply.github.com>
Date: Wed, 14 Feb 2024 11:22:06 +0000
Subject: [PATCH 3/3] Removed unrecognised command
---
.github/workflows/master.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/master.yml b/.github/workflows/master.yml
index 4808245..f8112e5 100644
--- a/.github/workflows/master.yml
+++ b/.github/workflows/master.yml
@@ -32,7 +32,7 @@ jobs:
pip install pylint black
- name: Format with black
run: |
- black . --line-length=100 --experimental-string-processing
+ black . --line-length=100
- name: Lint with Pylint
run: |
pylint aura/