You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fixed the review comments from Pekka and fixed multiple typos or grammar
issues.
This PR polishes the RFCP website content by correcting typos/grammar
and refining glossary terminology so the syllabus pages and glossary
tooltips read more consistently across the site.
**Changes:**
- Updated `glossary.json` definitions and added/adjusted several
glossary entries (e.g., dictionary/list variable syntax, IF statement,
suite directory).
- Corrected typos and grammar across multiple syllabus chapters,
overview pages, and the example exam page.
- Aligned repeated learning objective phrasing across docs, `README.md`,
and `LOs.csv`.
---------
Signed-off-by: René <snooz@posteo.de>
Co-authored-by: Gerwin <8427040+GerwinLaagland@users.noreply.github.com>
- LO-4.3 (K1) Recall how to define Initialization Files and its purpose
225
+
- LO-4.3 (K1) Recall how to define Initialization Files and their purpose
226
226
-[`4.3.1 Purpose of Initialization Files`](website/docs/chapter-04/03_init_files.md#431-purpose-of-initialization-files)
227
227
-[`4.3.2 Suite Setup and Suite Teardown of Initialization Files`](website/docs/chapter-04/03_init_files.md#432-suite-setup-and-suite-teardown-of-initialization-files)
228
228
- LO-4.3.2 (K2) Understand the execution order of Suite Setup and Suite Teardown in Initialization Files and their sub-suites and tests|tasks
Copy file name to clipboardExpand all lines: website/docs/chapter-01/01_purpose.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Robot Framework is typically not used for **component testing** nor **integratio
46
46
47
47
### 1.1.1.1 Synthetic Monitoring
48
48
49
-
Beyond traditional test levels, **Synthetic Monitoring**, also referred to as **Active Monitoring** or **Proactive Monitoring**, is a proactive approach that simulates user interactions with live systems at regular intervals. It detects performance issues or downtime early with the goal of detecting such failure before they affect actual users.
49
+
Beyond traditional test levels, **Synthetic Monitoring**, also referred to as **Active Monitoring** or **Proactive Monitoring**, is a proactive approach that simulates user interactions with live systems at regular intervals. It detects performance issues or downtime early with the goal of detecting such failures before they affect actual users.
Copy file name to clipboardExpand all lines: website/docs/chapter-01/04_styles.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,16 +16,16 @@ While **Keyword-Driven Testing (KDT)** and **Behavior-Driven Development (BDD)**
16
16
17
17
Both styles can be mixed, even within the same test or task, but it is strongly recommended to have separate styles for separate purposes and not mix them within the same body.
18
18
One practical solution would be to define acceptance test cases that cover users' expectations in a declarative *Behavior-Driven Style*, while using keywords that are implemented in an imperative *Keyword-Driven style*.
19
-
Further system level :term[test cases]{term="Test Case"}, that are not covering acceptance criteria could be written in a *Keyword-Driven style*.
19
+
Further system level :term[test cases]{term="Test Case"}, that are not covering acceptance criteria, could be written in a *Keyword-Driven style*.
20
20
21
21
The approach of both styles is different in that way,
22
22
that the *Behavior-Driven Style* is a **declarative** specification,
23
-
where the script describe/declare what the system should do or how it should behave,
23
+
where the script describes/declares what the system should do or how it should behave,
24
24
while the *Keyword-Driven Style* is an **imperative** specification,
25
25
where the script specifies what the automation should do to control the system.
26
26
27
27
28
-
Beside these two different specification approaches how to write/formulate
28
+
Besides these two different specification approaches how to write/formulate
29
29
your automation script and their step sequences,
30
30
there is also a third specification method, **Data-Driven Specification** that can be combined
31
31
with the other two styles, to define the data that is used in the automation.
Copy file name to clipboardExpand all lines: website/docs/chapter-02/01_suitefile.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ If the path to a single file is given as **Root Suite** directly to Robot Framew
19
19
20
20
If a directory path is given, starting at this location, Robot Framework will parse all `*.robot` files and directories within this path.
21
21
Robot Framework analyzes all containing files and determines if they contain test cases or tasks. If they do, they are considered **Suite Files** or **Low-Level Suites**.
22
-
All directories that either directly or indirectly contain a Suite File are considered **Suites Directories** or **Higher-Level Suites**.
22
+
All directories that either directly or indirectly contain a Suite File are considered **Suite Directories** or **Higher-Level Suites**.
23
23
24
24
The ordering of suites during execution is, by default, defined by their name and hierarchy.
25
25
All files and directories, which are suites in one directory, are considered on the same level and are executed in case-insensitive alphabetical order.
@@ -128,7 +128,7 @@ It allows you to import keywords from external libraries (`Library`) or resource
128
128
129
129
In this section, the suite name, that is normally derived from the file name, can be redefined with the `Name` setting and its documentation can be defined with the `Documentation` setting.
130
130
131
-
Additional metadata can be defined by multiple `Metadata` entries, which can contain key-value pairs that can be used to store additional information about the suite, like the author, the version, or related requirements of the suite.
131
+
Additional suite metadata can be defined by multiple `Metadata` entries, which can contain key-value pairs that can be used to store additional information about the suite, like the author, the version, or related requirements of the suite.
132
132
133
133
This section can also define keywords called for execution flow control, such as `Suite Setup` and `Suite Teardown`, which are executed before and after the suite's tests run. See [4.1 Setups (Suite, Test|Task, Keyword)](chapter-04/01_setups.md) and
134
134
[4.2 Teardowns (Suite, Test|Task, Keyword)](chapter-04/02_teardowns.md) for more information.
Copy file name to clipboardExpand all lines: website/docs/chapter-02/02_suitefile_syntax.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ Understand the basic syntax of test cases and tasks.
15
15
::::
16
16
17
17
Suite files and resource files share the same syntax, however they differ in their capabilities.
18
-
Resource files are explained in more detail in [2.4.2 Resource Files](chapter-02/04_keyword_imports.md#242-resource-files)[3.1 Resource File Structure](chapter-03/01_resource_file.md).
18
+
Resource files are explained in more detail in [2.4.2 Resource Files](chapter-02/04_keyword_imports.md#242-resource-files)and [3.1 Resource File Structure](chapter-03/01_resource_file.md).
19
19
20
20
21
21
## 2.2.1 Separation and Indentation
@@ -219,9 +219,9 @@ Some examples are:
219
219
All those characters or character sequences that are interpreted as control characters can be escaped by a backslash `\`.
220
220
This means that the character following the backslash is interpreted as a normal character and not as a control character.
221
221
222
-
This leads to the fact that a backslash itself must be escaped by another backslash to be interpreted as a normal backslash character. Therefore it is strongly recommended to use forward slashes `/` as path separators in paths also on windows environments and avoid backslashes `\` whenever possible.
222
+
This leads to the fact that a backslash itself must be escaped by another backslash to be interpreted as a normal backslash character. Therefore it is strongly recommended to use forward slashes `/` as path separators in paths also on Windows environments and avoid backslashes `\` whenever possible.
223
223
224
-
Leading and trailing spaces in values are normally considered being part of the separator surrounding the values.
224
+
Leading and trailing spaces in values are normally considered to be part of the separator surrounding the values.
225
225
If values shall contain leading or trailing spaces they must be either enclosed in backslashes `\` or replaced by the special variable `${SPACE}` that contains a single space character.
Copy file name to clipboardExpand all lines: website/docs/chapter-02/03_executing.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Understand how to run the `robot` command and its basic usage.
32
32
33
33
The `robot` command is used to run a Robot Framework execution, which will execute suites and their containing tests|tasks.
34
34
35
-
At a basic level, you can run `robot` by providing the path to a suite file or suite directory containing suite files as last argument.
35
+
At a basic level, you can run `robot` by providing the path to a suite file or suite directory containing suite files as the last argument.
36
36
```plaintext
37
37
robot <path_to_root_suite>
38
38
```
@@ -93,7 +93,7 @@ After executing a suite, Robot Framework, by default, generates three output fil
93
93
94
94
`log.html` and `report.html` are generated based on the information stored in `output.xml`.
95
95
96
-
A unique feature of Robot Framework is, that it logs each keyword call and its arguments with its log outputs and timestamps, so that it is possible to have a very detailed view of the execution flow and the data that was used during the execution.
96
+
A unique feature of Robot Framework is that it logs each keyword call and its arguments with its log outputs and timestamps, so that it is possible to have a very detailed view of the execution flow and the data that was used during the execution.
97
97
In case of a failure it is possible to see the exact keyword call that failed and the arguments that were used, which can be very helpful for debugging or reporting. Furthermore, you also get all passed keywords and even the non‑executed keywords, allowing you to trace the whole execution flow.
98
98
99
99
@@ -143,7 +143,7 @@ This status is used if an element was executed successfully without any errors o
143
143
144
144
**Atomic elements** are `PASS` if they were executed successfully without reporting an error by raising an exception.
145
145
146
-
**Composite elements** are `PASS` if all their executed body elements are pass.
146
+
**Composite elements** are `PASS` if all their executed body elements are `PASS`.
147
147
E.g. in case of User Keywords this means that if all keywords or Robot Framework language statements that were directly called by that User Keyword were `PASS` the User Keyword itself is considered `PASS`.
148
148
149
149
Library Keywords like `Run Keyword And Expect Error`, from BuiltIn Library, do `PASS` if the keyword they are internally calling does raise an error with the expected message or type.
@@ -170,12 +170,12 @@ Exceptions are teardowns, as explained in [Chapter 4: Advanced Structuring and E
170
170
171
171
**Atomic elements** are `FAIL` if they were tried to be executed but raised an exception.
172
172
173
-
**Composite elements** are `FAIL` if at least one of their executed direct body elements are`FAIL`.
173
+
**Composite elements** are `FAIL` if at least one of their executed direct body elements is`FAIL`.
174
174
Therefore a failure typically distributes upwards through the hierarchy of elements until it reaches the root suite.
175
175
176
176
A User Keyword is `FAIL` if one of its called Library Keywords is `FAIL`.
177
177
A test|task is `FAIL` if one of its directly called Keywords is `FAIL`.
178
-
A suite (file) is `FAIL` if one of its test|task is `FAIL` and
178
+
A suite (file) is `FAIL` if one of its tests|tasks is `FAIL` and
179
179
a suite (directory) is `FAIL` if one of its suites (file) is `FAIL`.
Copy file name to clipboardExpand all lines: website/docs/chapter-02/04_keyword_imports.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,17 +34,14 @@ Recall the three types of libraries in Robot Framework.
34
34
35
35
From a user perspective there are three different kinds of libraries:
36
36
-**Robot Framework Standard Libraries**: These are libraries that are shipped with Robot Framework and are available without any additional installation. See documentation of [ext: Robot Framework Standard Libraries](https://robotframework.org/robotframework/#standard-libraries) for more information.
37
-
-**3rd Party Libraries** / **External Libraries**: These are libraries have been developed and maintained by community members and have to be installed/downloaded separately.
37
+
-**3rd Party Libraries** / **External Libraries**: These are libraries that have been developed and maintained by community members and have to be installed/downloaded separately.
38
38
-**Custom Libraries**: These libraries are developed by the users themselves to solve specific problems or to encapsulate more complex functionality.
39
39
40
-
Further more detailed information about the different types of libraries and are described in later chapters.
41
-
{/* TODO: Do we fulfill this promise? */}
42
-
43
-
To import a library into a suite or resource file the `Library` setting is used in the `*** Settings ***` section followed by the name of the library as long as they are located in the Python module search path, which automatically happens if they are installed via `pip`.
40
+
To import a library into a suite or resource file the `Library` setting is used in the `*** Settings ***` section followed by the name of the library as long as it is located in the Python module search path, which automatically happens if it is installed via `pip`.
44
41
The name of the library is case-sensitive and should be taken from the library's keyword documentation.
45
42
By default, libraries in Robot Framework are implemented in Python and the name of the library is the name of the Python module that contains the library implementation.
46
43
47
-
Alternatively, if a library is not in Python module search path, a library can be imported using the path to the Python module. See [2.4.3 Import Paths](chapter-02/04_keyword_imports.md#243-import-paths).
44
+
Alternatively, if a library is not in the Python module search path, a library can be imported using the path to the Python module. See [2.4.3 Import Paths](chapter-02/04_keyword_imports.md#243-import-paths).
48
45
49
46
Be aware that the library [`BuiltIn`](https://robotframework.org/robotframework/latest/libraries/BuiltIn.html) is always imported invisibly and does not need to be imported explicitly.
0 commit comments