From d80eb15fa28fafc9bd32155ffb63559bfc5b5d2c Mon Sep 17 00:00:00 2001
From: Nick Todd <nick.todd@t-s.qinetiq.com>
Date: Wed, 8 May 2024 14:56:44 +0100
Subject: [PATCH] #2560: Fix typos and punctuation.

---
 .../network_simulator_demo.ipynb              | 26 ++++++++++---------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/src/primaite/simulator/_package_data/network_simulator_demo.ipynb b/src/primaite/simulator/_package_data/network_simulator_demo.ipynb
index 7f4cf3b1..a90c4751 100644
--- a/src/primaite/simulator/_package_data/network_simulator_demo.ipynb
+++ b/src/primaite/simulator/_package_data/network_simulator_demo.ipynb
@@ -54,7 +54,7 @@
     "## The Network\n",
     "First let's create our network. The network comes 'pre-packaged' with PrimAITE in the `primaite.simulator.network.networks` module.\n",
     "\n",
-    "> ℹ️ You'll see a bunch of logs associated with parts of the Network that aern't an 'electronic' device on the Network and thus don't have a stsrem to log to. Soon these logs are going to be pushed to a Network Logger so we're not clogging up the PrimAITE application logs."
+    "> ℹ️ You'll see a bunch of logs associated with parts of the Network that aren't an 'electronic' device on the Network and thus don't have a stream to log to. Soon these logs are going to be pushed to a Network Logger so we're not clogging up the PrimAITE application logs."
    ]
   },
   {
@@ -208,7 +208,9 @@
    "id": "17",
    "metadata": {},
    "source": [
-    "Calling `router.sys_log.show()` displays the Router system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=<number of log entries>`."
+    "Calling `router.sys_log.show()` displays the Router system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=<number of log entries>`.\n",
+    "\n",
+    "NB: For `sys_log.show()` to work correctly log files need to be created with a sys_log level of INFO or below."
    ]
   },
   {
@@ -230,7 +232,7 @@
    "source": [
     "### Switch Nodes\n",
     "\n",
-    "Next we'll inspect the Switch node and some of it's core services."
+    "Next we'll inspect the Switch node and some of its core services."
    ]
   },
   {
@@ -258,7 +260,7 @@
    "id": "22",
    "metadata": {},
    "source": [
-    "Calling `switch.sys_log.show()` displays the Switch system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=<number of log entries>`."
+    "Calling `switch.sys_log.show()` displays the Switch system log. By default; only the last 10 log entries are displayed, this can be changed by passing `last_n=<number of log entries>`."
    ]
   },
   {
@@ -330,7 +332,7 @@
    "id": "29",
    "metadata": {},
    "source": [
-    "Calling `computer.sys_log.show()` displays the Computer/Server system log. By default, only the last 10 log entries are displayed, this can be changed by passing `last_n=<number of log entries>`."
+    "Calling `computer.sys_log.show()` displays the Computer/Server system log. By default, only the last 10 log entries are displayed; this can be changed by passing `last_n=<number of log entries>`."
    ]
   },
   {
@@ -474,7 +476,7 @@
    "id": "43",
    "metadata": {},
    "source": [
-    "Let's attempt to prevent client_2 from being able to ping the web server. First, we'll confirm that it can ping the server first..."
+    "Let's attempt to prevent client_2 from being able to ping the web server. First, we'll confirm that it can ping the server..."
    ]
   },
   {
@@ -494,7 +496,7 @@
    "id": "45",
    "metadata": {},
    "source": [
-    "If we look at the client_2 sys log we can see that the four ICMP echo requests were sent and four ICMP each replies were received:"
+    "If we look at the client_2 sys log we can see that the four ICMP echo requests were sent and four ICMP each replies were received."
    ]
   },
   {
@@ -514,7 +516,7 @@
    "id": "47",
    "metadata": {},
    "source": [
-    "Now we'll add an ACL to block ICMP from 192.168.10.22"
+    "Now we'll add an ACL to block ICMP from 192.168.10.22."
    ]
   },
   {
@@ -554,7 +556,7 @@
    "id": "50",
    "metadata": {},
    "source": [
-    "Now we attempt (and fail) to ping the web server"
+    "Now we attempt (and fail) to ping the web server."
    ]
   },
   {
@@ -574,7 +576,7 @@
    "id": "52",
    "metadata": {},
    "source": [
-    "We can check that the ping was actually sent by client_2 by viewing the sys log"
+    "We can check that the ping was actually sent by client_2 by viewing the sys log."
    ]
   },
   {
@@ -594,7 +596,7 @@
    "id": "54",
    "metadata": {},
    "source": [
-    "We can check the router sys log to see why the traffic was blocked"
+    "We can check the router sys log to see why the traffic was blocked."
    ]
   },
   {
@@ -658,7 +660,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.11"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,