Minor readability and clarity fixes

opensafely · Sep 27, 2024 · 28584a2 · 28584a2
1 parent fbcc2ca
commit 28584a2
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/docs/getting-started/tutorial/create-a-github-codespace/index.md b/docs/getting-started/tutorial/create-a-github-codespace/index.md
@@ -28,7 +28,7 @@ commands on a computer (virtual machine) provided by GitHub.
 The large, upper-right area holds the **main editor**, which is where you will
 view and edit files that you are working on. The left **"side bar"**
 holds the Explorer when you first start the codespace. There are
-other useful menus in this area that can be switched with the icons
+other useful menus in this area that can be accessed with the icons
 to the far left side. Finally, the button at the top-left with three
 horizontal lines (`≡`) is the **menu button**, which allows you to
 access many more options.

diff --git a/docs/getting-started/tutorial/generate-a-first-dataset/index.md b/docs/getting-started/tutorial/generate-a-first-dataset/index.md
@@ -8,6 +8,8 @@ opensafely exec ehrql:v1 generate-dataset analysis/dataset_definition.py
 
 pressing ++enter++ once you've typed the command.
 
+This command makes use of files that already exist in the repository to generate a dummy dataset.
+
 The first time you run this command, it may take a few seconds to download the
 required software. Eventually, you should see output that contains lines like the following:
 

diff --git a/docs/getting-started/tutorial/introduction/index.md b/docs/getting-started/tutorial/introduction/index.md
@@ -1,7 +1,7 @@
 OpenSAFELY is designed to allow you to do your analytic work on your own
 computer, without ever having to access the real, sensitive, patient-level data.
 
-Because the study uses dummy patient data,
+Because the tutorial study uses dummy patient data,
 anyone can complete the tutorial.
 
 We ask all potential collaborators to complete this tutorial

diff --git a/docs/getting-started/tutorial/run-the-project-pipeline/index.md b/docs/getting-started/tutorial/run-the-project-pipeline/index.md
@@ -19,7 +19,7 @@ defines the actions for an OpenSAFELY project pipeline.
 ## The `project.yaml` file
 
 In the Visual Studio Code file Explorer,
-open the `project.yaml` file by clicking on it.
+open the `project.yaml` file by clicking on it. This file will be near the end of the list of files and folders.
 
 You should see a tab with the following content:
 
@@ -38,7 +38,7 @@ actions:
         dataset: output/dataset.csv.gz
 ```
 
-There is a single actions defined called `generate_dataset`
+There is a single action defined, called `generate_dataset`,
 in this project pipeline.
 
 The highlighted line is the command that the action runs,

diff --git a/docs/getting-started/tutorial/update-the-dataset-definition/index.md b/docs/getting-started/tutorial/update-the-dataset-definition/index.md
@@ -1,4 +1,4 @@
-You've successfully generated a dataset from the code in your study, but at the moment it only adds one data column.
+You've successfully generated a dataset from the code in your study, but at the moment it only contains one data column.
 
 Now we'll add some code to create an extra column.
 
@@ -38,9 +38,7 @@ to the age of each patient on the given date*".
    opensafely exec ehrql:v1 generate-dataset analysis/dataset_definition.py
    ```
 
-   and press ++enter++, you will see a new randomly generated dataset.
-
-   However, this time it contains the additional `age` column.
+   and press ++enter++, you will see a new randomly generated dataset which now contains the additional `age` column.
 
 ---