Skip to content

Commit 71b1b2c

Browse files
Snooz82Copilot
andcommitted
fixed glossary feedback
Co-authored-by: Copilot <copilot@github.com>
1 parent 5e114d7 commit 71b1b2c

4 files changed

Lines changed: 67 additions & 55 deletions

File tree

website/docs/chapter-02/01_suitefile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ It allows you to import keywords from external libraries (`Library`) or resource
128128

129129
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.
130130

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.
132132

133133
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
134134
[4.2 Teardowns (Suite, Test|Task, Keyword)](chapter-04/02_teardowns.md) for more information.

website/docs/chapter-04/03_init_files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following sections are allowed in initialization files:
6868
- **`*** Settings ***` Section (required)**:
6969
- `Name`: Set a custom name for the suite directory.
7070
- `Documentation`: Provide documentation for the suite.
71-
- `Metadata`: Add metadata to the suite.
71+
- `Metadata`: Add suite metadata.
7272
- `Suite Setup`: Define a keyword to be executed before any tests|tasks or child suites.
7373
- `Suite Teardown`: Define a keyword to be executed after all tests|tasks and child suites have completed.
7474
- `Test Setup`|`Task Setup`: Set a default setup keyword for all tests|tasks in the suite (can be overridden in lower-level suites or tests|tasks).

website/docs/chapter-04/04_tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Recall the purpose of Test|Task Tags in Robot Framework
1212
::::
1313

1414
In Robot Framework, **tags** offer a simple yet powerful mechanism for classifying and controlling the execution of tests|tasks.
15-
Tags are free-form text labels that can be assigned to tests|tasks to provide metadata, enable flexible test selection, and organize test results.
15+
Tags are free-form text labels that can be assigned to tests|tasks to provide meta information, enable flexible test selection, and organize test results.
1616

1717
Tags are also used to create a statistical summary of the test|task results in the execution protocols.
1818

website/static/glossary/glossary.json

Lines changed: 64 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
"term": "Behavior-Driven Specification",
4646
"aliases": [],
4747
"abbreviation": "",
48-
"definition": "Declarative Robot Framework style where tests|tasks describe system behavior from the user perspective using natural-language-like steps with embedded arguments and optional Given/When/Then/And/But prefixes."
48+
"definition": "Declarative Robot Framework style in which tests or tasks describe system behavior from the user's perspective using natural-language-like steps with embedded arguments and optional Given/When/Then/And/But prefixes."
4949
},
5050
{
5151
"term": "Built-In Variables",
@@ -63,7 +63,7 @@
6363
"term": "Composite Element",
6464
"aliases": [],
6565
"abbreviation": "",
66-
"definition": "Execution element composed of child elements (for example suites with tests|tasks, tests|tasks with keywords, or user keywords with child steps) whose status is derived from its children."
66+
"definition": "Execution element composed of child elements (for example suites with tests or tasks, tests or tasks with keywords, or user keywords with child steps) whose status is derived from its children."
6767
},
6868
{
6969
"term": "Control Structure",
@@ -75,14 +75,20 @@
7575
"term": "Data-Driven Specification",
7676
"aliases": [],
7777
"abbreviation": "",
78-
"definition": "Specification style where the same logic or test flow is executed multiple times with varying input or expected output data, often implemented with test|task templates."
78+
"definition": "Specification style where the same logic or test flow is executed multiple times with varying input or expected output data, often implemented with test or task templates."
7979
},
8080
{
8181
"term": "Definition Layer",
8282
"aliases": [],
8383
"abbreviation": "",
8484
"definition": "Layer in the Generic Test Automation Architecture (gTAA) containing test data such as suites, tests, tasks, resource files, keywords, and variables written in Robot Framework syntax."
8585
},
86+
{
87+
"term": "Dictionary Variable",
88+
"aliases": [],
89+
"abbreviation": "&{}",
90+
"definition": "Robot Framework variable of dictionary type created with the `&{}` syntax that holds key-value pairs and can be accessed by keys."
91+
},
8692
{
8793
"term": "Embedded Argument",
8894
"aliases": [],
@@ -99,7 +105,7 @@
99105
"term": "Execution Artifacts",
100106
"aliases": [],
101107
"abbreviation": "",
102-
"definition": "Files produced by Robot Framework executionsuch as `output.xml`, `log.html`, and `report.html`that document what was executed and with which results."
108+
"definition": "Files generated by a Robot Framework execution (such as `output.xml`, `log.html`, and `report.html`) that document the execution process and its results."
103109
},
104110
{
105111
"term": "Execution Layer",
@@ -128,13 +134,13 @@
128134
{
129135
"term": "Free Named Argument",
130136
"aliases": ["**kwargs"],
131-
"abbreviation": "kwargs",
137+
"abbreviation": "",
132138
"definition": "Catch-all named argument kind in a keyword specification, marked with **, that gathers all named values not explicitly defined elsewhere into a dictionary."
133139
},
134140
{
135141
"term": "Generic Test Automation Architecture",
136142
"aliases": ["gTAA"],
137-
"abbreviation": "gTAA",
143+
"abbreviation": "",
138144
"definition": "Layered reference architecture for test automation that separates definition, execution, and adaptation layers and describes Robot Framework’s role in an automation solution."
139145
},
140146
{
@@ -150,14 +156,14 @@
150156
"definition": "Variable with global scope that can be accessed from all suites and keywords in a Robot Framework execution."
151157
},
152158
{
153-
"term": "Higher-Level Suite (Suite Directory)",
154-
"aliases": [],
155-
"abbreviation": "",
156-
"definition": "Directory treated as a suite because it directly or indirectly contains at least one suite file, grouping lower-level suites into a suite tree."
159+
"term": "IF statement",
160+
"aliases": ["IF/ELSE"],
161+
"abbreviation": "IF",
162+
"definition": "Control structure in Robot Framework used to execute one block of statements when a condition is true and optionally alternative blocks with `ELSE IF` or `ELSE` when it is not."
157163
},
158164
{
159-
"term": "Initialization File (__init__.robot)",
160-
"aliases": [],
165+
"term": "Initialization File",
166+
"aliases": ["__init__.robot", "Suite Initialization File"],
161167
"abbreviation": "",
162168
"definition": "Suite file located in a directory that configures that directory as a suite and defines suite-level settings, variables, setups, and teardowns for contained suites."
163169
},
@@ -173,12 +179,6 @@
173179
"abbreviation": "",
174180
"definition": "Compact single-line IF statement (`IF <condition> <keyword> [args]`) used to execute one keyword conditionally without an END."
175181
},
176-
{
177-
"term": "K-Level (Knowledge Level)",
178-
"aliases": [],
179-
"abbreviation": "",
180-
"definition": "Categorization of learning objectives based on Bloom’s Taxonomy: K1 (Remember), K2 (Understand), and K3 (Apply), indicating expected depth of knowledge."
181-
},
182182
{
183183
"term": "Keyword",
184184
"aliases": [],
@@ -189,25 +189,31 @@
189189
"term": "Keyword Interface",
190190
"aliases": [],
191191
"abbreviation": "",
192-
"definition": "Documented information of a keywordincluding name, arguments with kinds and types, return values, documentation, and examplesas exposed by HTML documentation or IDEs."
192+
"definition": "Documented information about a keyword, including its name, arguments with kinds and types, return values, documentation, and examples, as exposed by HTML documentation or IDEs."
193193
},
194194
{
195195
"term": "Keyword-Driven Specification",
196196
"aliases": [],
197197
"abbreviation": "",
198-
"definition": "Imperative Robot Framework style where tests|tasks are written as sequences of keyword calls with arguments, focusing on executed actions and their order."
198+
"definition": "Imperative Robot Framework style where tests or tasks are written as sequences of keyword calls with arguments, focusing on executed actions and their order."
199199
},
200200
{
201201
"term": "Keyword Library",
202202
"aliases": ["Library"],
203203
"abbreviation": "",
204204
"definition": "Collection of library keywords implemented typically in Python (or other languages) that Robot Framework imports to interact with external systems, perform computations, or provide utility functions."
205205
},
206+
{
207+
"term": "Knowledge Level",
208+
"aliases": [],
209+
"abbreviation": "K-Level",
210+
"definition": "Categorization of learning objectives based on Bloom’s Taxonomy: K1 (Remember), K2 (Understand), and K3 (Apply), indicating expected depth of knowledge."
211+
},
206212
{
207213
"term": "List Variable",
208214
"aliases": [],
209-
"abbreviation": "",
210-
"definition": "Robot Framework variable of list type accessed with the `@{}` syntax that holds an ordered collection of values and can be unpacked when passed to keywords."
215+
"abbreviation": "@{}",
216+
"definition": "Robot Framework variable of list type created with the `@{}` syntax that holds an ordered collection of values and can be unpacked when passed to keywords."
211217
},
212218
{
213219
"term": "Local Variable",
@@ -216,8 +222,8 @@
216222
"definition": "Variable whose scope is limited to a single keyword, test, or task execution and is not visible outside that body."
217223
},
218224
{
219-
"term": "Log File (log.html)",
220-
"aliases": [],
225+
"term": "Log File",
226+
"aliases": ["log.html"],
221227
"abbreviation": "",
222228
"definition": "Detailed HTML execution log (log.html) generated by Robot Framework that shows keyword-level execution steps, arguments, messages, and statuses."
223229
},
@@ -228,10 +234,10 @@
228234
"definition": "Argument kind in a keyword specification without a default value that must be provided in calls and that precedes optional arguments."
229235
},
230236
{
231-
"term": "Metadata (Suite Metadata)",
237+
"term": "Suite Metadata",
232238
"aliases": [],
233239
"abbreviation": "",
234-
"definition": "Key–value information defined with the Metadata setting in a suite to document attributes such as author, version, or related requirements."
240+
"definition": "Key–value information defined with the `Metadata` setting in a suite to document attributes such as author, version, or related requirements."
235241
},
236242
{
237243
"term": "Named-Only Argument",
@@ -246,10 +252,10 @@
246252
"definition": "Argument value provided in a keyword call using an explicit name=value pair."
247253
},
248254
{
249-
"term": "Output File (output.xml)",
250-
"aliases": [],
255+
"term": "Output File",
256+
"aliases": ["output.xml"],
251257
"abbreviation": "",
252-
"definition": "Machine-readable execution result file (output.xml) produced by Robot Framework that contains the full execution tree, messages, and statistics in XML format."
258+
"definition": "Primary machine-readable execution result file (e.g.`output.xml`) produced by Robot Framework that stores the full execution tree, messages, and statistics and serves as the source for generating log and report files."
253259
},
254260
{
255261
"term": "Optional Argument",
@@ -276,10 +282,10 @@
276282
"definition": "Argument kind in a keyword specification that can be set either by position or by name (but not both for the same value) and that may be mandatory or optional."
277283
},
278284
{
279-
"term": "Report File (report.html)",
280-
"aliases": [],
285+
"term": "Report File",
286+
"aliases": ["report.html"],
281287
"abbreviation": "",
282-
"definition": "High-level HTML summary (report.html) of a Robot Framework execution that focuses on statistics and overall pass/fail status of suites and tests|tasks."
288+
"definition": "High-level HTML summary (`report.html`) of a Robot Framework execution that focuses on statistics and the overall pass/fail status of suites and tests or tasks."
283289
},
284290
{
285291
"term": "Resource File",
@@ -288,8 +294,8 @@
288294
"definition": "File (commonly with extension .resource or .robot) that contains user keywords and variables and is imported by suites to share and reuse these artifacts."
289295
},
290296
{
291-
"term": "Return Statement (RETURN)",
292-
"aliases": [],
297+
"term": "RETURN Statement",
298+
"aliases": ["RETURN"],
293299
"abbreviation": "",
294300
"definition": "Statement used in user keywords to return one or more values that can be assigned to variables in the calling context."
295301
},
@@ -302,7 +308,7 @@
302308
{
303309
"term": "Robotic Process Automation",
304310
"aliases": ["RPA"],
305-
"abbreviation": "RPA",
311+
"abbreviation": "",
306312
"definition": "Automation of business processes or tasks normally performed by humans, often across multiple systems, without necessarily focusing on testing."
307313
},
308314
{
@@ -314,7 +320,7 @@
314320
{
315321
"term": "Robot Framework® Certified Professional",
316322
"aliases": ["RFCP"],
317-
"abbreviation": "RFCP",
323+
"abbreviation": "",
318324
"definition": "Foundational certification level for Robot Framework that validates understanding of core concepts, syntax, and basic control structures."
319325
},
320326
{
@@ -324,10 +330,10 @@
324330
"definition": "Top-level suite in a Robot Framework execution determined by the initial directory or file path passed to the `robot` command."
325331
},
326332
{
327-
"term": "Scalar Access Syntax (${})",
333+
"term": "Scalar Access Syntax",
328334
"aliases": [],
329-
"abbreviation": "",
330-
"definition": "Standard variable access form in Robot Framework used to read values regardless of whether the underlying variable was defined as scalar, list-like, or dictionary-like."
335+
"abbreviation": "${}",
336+
"definition": "Standard variable access form `${}` in Robot Framework used to read values regardless of whether the underlying variable was defined as scalar, list-like, or dictionary-like."
331337
},
332338
{
333339
"term": "Scalar Variable",
@@ -342,17 +348,23 @@
342348
"definition": "Execution status indicating that an element (such as a test or task) was intentionally not executed, for example due to selection options or an explicit skip."
343349
},
344350
{
345-
"term": "Standard Library (Robot Framework)",
351+
"term": "Standard Library",
346352
"aliases": [],
347353
"abbreviation": "",
348354
"definition": "Library shipped with Robot Framework itself providing generic functionality such as operating system interaction, string manipulation, or process handling."
349355
},
350356
{
351-
"term": "Suite (Test Suite / Task Suite)",
352-
"aliases": [],
357+
"term": "Suite",
358+
"aliases": ["Test Suite", "Task Suite"],
353359
"abbreviation": "",
354360
"definition": "Collection of tests or tasks (optionally with local keywords and variables) defined in a .robot file or directory that is executed as a unit by Robot Framework."
355361
},
362+
{
363+
"term": "Suite Directory",
364+
"aliases": ["Higher-Level Suite"],
365+
"abbreviation": "",
366+
"definition": "Directory treated as a suite because it directly or indirectly contains at least one suite file, grouping lower-level suites into a suite tree."
367+
},
356368
{
357369
"term": "Suite File",
358370
"aliases": [],
@@ -363,19 +375,19 @@
363375
"term": "Suite Setup",
364376
"aliases": [],
365377
"abbreviation": "",
366-
"definition": "Keyword executed once before any tests|tasks in a suite are run, typically used to prepare common preconditions."
378+
"definition": "Keyword executed once before any tests or tasks in a suite are run, typically used to prepare common preconditions."
367379
},
368380
{
369381
"term": "Suite Teardown",
370382
"aliases": [],
371383
"abbreviation": "",
372-
"definition": "Keyword executed once after all tests|tasks in a suite have run, typically used to clean up shared resources."
384+
"definition": "Keyword executed once after all tests or tasks in a suite have run, typically used to clean up shared resources."
373385
},
374386
{
375387
"term": "Suite Variable",
376388
"aliases": [],
377389
"abbreviation": "",
378-
"definition": "Variable whose scope covers all tests|tasks and keywords within a specific suite but is not visible outside that suite."
390+
"definition": "Variable whose scope covers all tests or tasks and keywords within a specific suite but is not visible outside that suite."
379391
},
380392
{
381393
"term": "Synthetic Monitoring",
@@ -385,32 +397,32 @@
385397
},
386398
{
387399
"term": "Task",
388-
"aliases": ["Test Case"],
400+
"aliases": [],
389401
"abbreviation": "",
390402
"definition": "Executable entity in Robot Framework similar to a test case but used for non-testing automation such as RPA workflows, defined in a `*** Tasks ***` section."
391403
},
392404
{
393405
"term": "Test Setup",
394406
"aliases": ["Task Setup"],
395407
"abbreviation": "",
396-
"definition": "Keyword executed before an individual test or task starts to prepare preconditions specific to that test|task."
408+
"definition": "Keyword executed before an individual test or task starts to prepare preconditions specific to that test or task."
397409
},
398410
{
399411
"term": "Test Teardown",
400412
"aliases": ["Task Teardown"],
401413
"abbreviation": "",
402-
"definition": "Keyword executed after an individual test or task finishes to clean up resources specific to that test|task."
414+
"definition": "Keyword executed after an individual test or task finishes to clean up resources specific to that test or task."
403415
},
404416
{
405417
"term": "Test Template",
406418
"aliases": ["Task Template"],
407419
"abbreviation": "",
408-
"definition": "Setting that defines a keyword used as a template for multiple tests|tasks, where each row of data calls the template keyword with different arguments."
420+
"definition": "Setting that defines a keyword used as a template for multiple tests or tasks, where each row of data calls the template keyword with different arguments."
409421
},
410422
{
411423
"term": "Test Case",
412-
"aliases": ["Task"],
413-
"abbreviation": "Test",
424+
"aliases": ["Test"],
425+
"abbreviation": "",
414426
"definition": "Executable specification in Robot Framework that verifies some aspect of system behavior and is defined in a `*** Test Cases ***` section."
415427
},
416428
{
@@ -465,7 +477,7 @@
465477
"term": "Variable Scope",
466478
"aliases": [],
467479
"abbreviation": "",
468-
"definition": "Visibility and lifetime of a variable (such as global, suite, test|task, or local) during a Robot Framework execution."
480+
"definition": "Visibility and lifetime of a variable (such as global, suite, test or task, or local) during a Robot Framework execution."
469481
},
470482
{
471483
"term": "WHILE Loop",

0 commit comments

Comments
 (0)