From d66b709bb4703b543131e9b4585f8baaa77a0fb2 Mon Sep 17 00:00:00 2001
From: smark-1 <75799735+smark-1@users.noreply.github.com>
Date: Sun, 24 Nov 2024 19:14:45 -0500
Subject: [PATCH] add docs

---
 Makefile  | 2 +-
 README.md | 1 +
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/Makefile b/Makefile
index 11e7502..99e6911 100644
--- a/Makefile
+++ b/Makefile
@@ -43,7 +43,7 @@ migrate: ## Migrate the wagtail bakery site migrations
 test: ## Run all wagtail tests or pass in a file with `make test file=wagtail.admin.tests.test_name`
 	docker compose exec -w /code/wagtail web python runtests.py $(file) $(FILE)
 
-test-parallel: ## Same as make test but will run tests in parallel
+test-parallel: ## Equivalent to make test, but runs tests in parallel
 	docker compose exec -w /code/wagtail web python runtests.py $(file) $(FILE) --parallel
 	
 format-wagtail: ## Format Wagtail repo
diff --git a/README.md b/README.md
index 4bbc108..0598055 100644
--- a/README.md
+++ b/README.md
@@ -136,6 +136,7 @@ docker compose down
 ### Run tests
 
 ```sh
+# run make test-parallel for tests to run faster but error messages can be more cryptic
 make test
 ```