File 0527-doc-improve-wording-of-test-groups-docs.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0527-doc-improve-wording-of-test-groups-docs.patch of Package erlang

From e072e71c5b2fcb76c89df2476502efa448410179 Mon Sep 17 00:00:00 2001
From: Kiko Fernandez-Reyes <kiko@erlang.org>
Date: Fri, 21 Oct 2022 09:01:28 +0200
Subject: [PATCH 2/2] doc: improve wording of test groups docs

---
 lib/common_test/doc/src/write_test_chapter.xml | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index b80ae6a8a2..075d6872ae 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -449,7 +449,7 @@
 functions and execution properties. Test case groups are defined by
 function
 <seemfa marker="ct_suite#Module:groups/0"><c>groups/0</c></seemfa>
- according to the following syntax:
+ that should return a term having the following syntax:
 <pre>
 groups() -> GroupDefs
 
@@ -551,9 +551,9 @@
 [{tests2, default,
 [{tests3, [parallel,{repeat,100}]}]}]}].</pre>
 
- For ease of readibility, all syntax definitions can be replaced by a function
+ For ease of readability, all syntax definitions can be replaced by a function
 call whose return value should match the expected syntax case.
- Example
+ Example:
 <pre>
 all() ->
 [{group, tests1, default, test_cases()},
@@ -563,8 +563,7 @@
 [{tests2, [parallel]}, {tests3, default}].
 
 shuffle_test() ->
- {tests2, [shuffle,{repeat,10}]}.
- </pre>
+ {tests2, [shuffle,{repeat,10}]}.</pre>
 
 The described syntax can also be used in test specifications
 to change group properties at the time of execution,
-- 
2.35.3

Places

File 0527-doc-improve-wording-of-test-groups-docs.patch of Package erlang

Places