Skip to content

Commit 2d92f69

Browse files
markdown fixes
1 parent a712ff6 commit 2d92f69

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

docs/getting-started/1_Understanding_Playwright_Python.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ through a browser to generate the code for a test. You can access the `codegen`
7171

7272
This will bring up a browser window, with the Playwright code generator running alongside, like so:
7373

74+
<!-- vale off -->
7475
![An image of the Playwright codegen tool](./img/1-codegen.png "Playwright codegen")
76+
<!-- vale on -->
7577

7678
When using the `codegen` tool, it is recommended to do the following:
7779

@@ -92,5 +94,5 @@ understanding of how to construct tests using Playwright Python, but you will so
9294

9395
[Chromium](https://www.chromium.org/Home/) is one of the open source browser that comes bundled with Playwright on install (if using the instructions
9496
within the [README](../../README.md) of this blueprint) but also more importantly, serves as the base code for both Google Chrome and Microsoft Edge.
95-
Whilst this doesn't replace the need to test in independent browsers as required, Chromium provides the opportunity to do some initial broad testing
97+
Whilst this doesn't replace the need to test in independent browsers as required, Chromium provides the opportunity to do some initial broad testing
9698
which should largely be representative of the user experience with Chrome and Edge respectively.

docs/getting-started/2_Blueprint_File_Breakdown.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This guide outlines the breakdown of this blueprint, and specifically the files
1212
- [`tests/`](#tests)
1313
- [`pages/`](#pages)
1414
- [`utils/`](#utils)
15-
- [Directories \& Files Specific For This Repo](#directories--files-specific-for-this-repo)
15+
- [Directories \& Files Specific For This Repository](#directories--files-specific-for-this-repository)
1616

1717
## Directories & Files Directly Impacting Tests
1818

@@ -52,14 +52,13 @@ We want this directory to be treated as a [Python package](https://docs.python.o
5252

5353
> NOTE: If you write a utility class for your own project that you think other projects may benefit from and can be applied in a generic way, please raise a [Feature Request](https://github.com/nhs-england-tools/playwright-python-blueprint/issues/new/choose) as we welcome any contributions of this fashion.
5454
55-
## Directories & Files Specific For This Repo
55+
## Directories & Files Specific For This Repository
5656

57-
The following directories and files are specific for this repository (playwright-python-blueprint), and may require modification or removal
58-
if transferring this code into a new repository.
57+
The following directories and files are specific for this repository, and may require modification or removal if transferring this code into a new repository.
5958

60-
- `.github/`: This directory has the code used to manage our repo and pipelines including CI/CD checks. You may find some useful for your own repo, especially if you are using GitHub to manage your code.
59+
- `.github/`: This directory has the code used to manage our repository and pipelines including CI/CD checks. You may find some useful for your own repository, especially if you are using GitHub to manage your code.
6160
- `.vscode/`: This directory houses the default recommended configuration and settings for VSCode, if you use it as an IDE.
6261
- `docs/`: This directory houses the documentation for this repo (including documents like this one).
6362
- `scripts/`: This directory houses the scripts used by this repo, primarily as part of the CI/CD checks.
64-
- `tests_utils/`: This directory houses the unit tests for the utilities provided by this repo. You may want to copy these over if you want to ensure utilities are behaving as expected.
63+
- `tests_utils/`: This directory houses the unit tests for the utilities provided by this repository. You may want to copy these over if you want to ensure utilities are behaving as expected.
6564
- `.editorconfig`, `.gitattributes`, `.gitignore`, `.gitleaks.toml`, `.gitleaksignore`: These files are configuration for git, and quality and security checks provided via the CI/CD checks.

0 commit comments

Comments
 (0)