Skip to content

Commit e1e1d3e

Browse files
oboehmeroboehmer
authored
Merge branch 'master' into 2285-continue-tag
2 parents d59aa9e + fc57664 commit e1e1d3e

File tree

16 files changed

+104
-116
lines changed

16 files changed

+104
-116
lines changed

‎atest/robot/standard_libraries/string/should_be.robot

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,16 @@ Should Be Byte String Negative
4444
[Tags] no-ipy
4545
Check Test Case ${TESTNAME}
4646

47-
Should Be Lowercase Positive
47+
Should Be Lower Case Positive
4848
Check Test Case ${TESTNAME}
4949

50-
Should Be Lowercase Negative
50+
Should Be Lower Case Negative
5151
Check Test Case ${TESTNAME}
5252

53-
Should Be Uppercase Positive
53+
Should Be Upper Case Positive
5454
Check Test Case ${TESTNAME}
5555

56-
Should Be Uppercase Negative
56+
Should Be Upper Case Negative
5757
Check Test Case ${TESTNAME}
5858

5959
Should Be Title Case Positive

‎atest/testdata/standard_libraries/string/should_be.robot

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -47,23 +47,23 @@ Should Be Byte String Negative
4747
'Hyvä' is not a byte string. Should Be Byte String Hyvä
4848
My error Should Be Byte String ${0} My error
4949

50-
Should Be Lowercase Positive
51-
Should Be Lowercase foo bar
52-
Should Be Lowercase ${BYTES.lower()}
50+
Should Be Lower Case Positive
51+
Should Be Lower Case foo bar
52+
Should Be Lower Case ${BYTES.lower()}
5353

54-
Should Be Lowercase Negative
54+
Should Be Lower Case Negative
5555
[Template] Run Keyword And Expect Error
56-
'${BYTES}' is not lowercase. Should Be Lowercase ${BYTES}
57-
My error Should Be Lowercase UP! My error
56+
'${BYTES}' is not lower case. Should Be Lower Case ${BYTES}
57+
My error Should Be Lower Case UP! My error
5858

59-
Should Be Uppercase Positive
60-
Should Be Uppercase FOO BAR
61-
Should Be Uppercase ${BYTES.upper()}
59+
Should Be Upper Case Positive
60+
Should Be Upper Case FOO BAR
61+
Should Be Upper Case ${BYTES.upper()}
6262

63-
Should Be Uppercase Negative
63+
Should Be Upper Case Negative
6464
[Template] Run Keyword And Expect Error
65-
'${BYTES}' is not uppercase. Should Be Uppercase ${BYTES}
66-
Custom error Should Be Uppercase low... Custom error
65+
'${BYTES}' is not upper case. Should Be Upper Case ${BYTES}
66+
Custom error Should Be Upper Case low... Custom error
6767

6868
Should Be Title Case Positive
6969
Should Be Title Case Foo Bar!

‎doc/userguide/src/Appendices/AvailableSettings.rst

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ All available settings in test data
55
:depth: 2
66
:local:
77

8-
Setting table
9-
-------------
8+
Setting section
9+
---------------
1010

11-
The Setting table is used to import test libraries, resource files and
11+
The Setting section is used to import test libraries, resource files and
1212
variable files and to define metadata for test suites and test
1313
cases. It can be included in test case files and resource files. Note
14-
that in a resource file, a Setting table can only include settings for
14+
that in a resource file, a Setting section can only include settings for
1515
importing libraries, resources, and variables.
1616

17-
.. table:: Settings available in the Setting table
17+
.. table:: Settings available in the Setting section
1818
:class: tabular
1919

2020
+-----------------+--------------------------------------------------------+
@@ -56,23 +56,19 @@ importing libraries, resources, and variables.
5656
| Task Timeout | |
5757
+-----------------+--------------------------------------------------------+
5858

59-
.. note:: All setting names can optionally include a colon at the end, for
60-
example :setting:`Documentation:`. This can make reading the settings easier
61-
especially when using the plain text format.
62-
6359
__ `Test suite documentation`_
6460
__ `Documenting resource files`_
6561

66-
Test Case table
67-
---------------
62+
Test Case section
63+
-----------------
6864

69-
The settings in the Test Case table are always specific to the test
65+
The settings in the Test Case section are always specific to the test
7066
case for which they are defined. Some of these settings override the
71-
default values defined in the Settings table.
67+
default values defined in the Settings section.
7268

73-
Exactly same settings are available when `creating tasks`_ in the Task table.
69+
Exactly same settings are available when `creating tasks`_ in the Task section.
7470

75-
.. table:: Settings available in the Test Case table
71+
.. table:: Settings available in the Test Case section
7672
:class: tabular
7773

7874
+-----------------+--------------------------------------------------------+
@@ -91,13 +87,13 @@ Exactly same settings are available when `creating tasks`_ in the Task table.
9187
| [Timeout] | Used for specifying a `test case timeout`_. |
9288
+-----------------+--------------------------------------------------------+
9389

94-
Keyword table
95-
-------------
90+
Keyword section
91+
---------------
9692

97-
Settings in the Keyword table are specific to the user keyword for
93+
Settings in the Keyword section are specific to the user keyword for
9894
which they are defined.
9995

100-
.. table:: Settings available in the Keyword table
96+
.. table:: Settings available in the Keyword section
10197
:class: tabular
10298

10399
+-----------------+--------------------------------------------------------+

‎doc/userguide/src/CreatingTestData/CreatingTasks.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Task syntax
2323

2424
Tasks are created based on the available keywords exactly like test cases,
2525
and the task syntax is in general identical to the `test case syntax`_.
26-
The main difference is that tasks are created in task sections (or tables)
27-
instead of test case sections:
26+
The main difference is that tasks are created in Task sections
27+
instead of Test Case sections:
2828

2929
.. sourcecode:: robotframework
3030

@@ -45,5 +45,5 @@ the `test case section`__. In the `setting section`__ it is possible to use
4545
:setting:`Task Setup`, :setting:`Task Teardown`, :setting:`Task Template`
4646
and :setting:`Task Timeout` instead of their :setting:`Test` variants.
4747

48-
__ `Settings in the Test Case table`_
49-
__ `Test case related settings in the Setting table`_
48+
__ `Settings in the Test Case section`_
49+
__ `Test case related settings in the Setting section`_

‎doc/userguide/src/CreatingTestData/CreatingTestCases.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ Test case syntax
2222
Basic syntax
2323
~~~~~~~~~~~~
2424

25-
Test cases are constructed in test case tables from the available
25+
Test cases are constructed in test case sections from the available
2626
keywords. Keywords can be imported from `test libraries`_ or `resource
27-
files`_, or created in the `keyword table`_ of the test case file
27+
files`_, or created in the `keyword section`_ of the test case file
2828
itself.
2929

30-
.. _keyword table: `user keywords`_
30+
.. _keyword section: `user keywords`_
3131

32-
The first column in the test case table contains test case names. A
32+
The first column in the test case section contains test case names. A
3333
test case starts from the row with something in this column and
34-
continues to the next test case name or to the end of the table. It is
35-
an error to have something between the table headers and the first
34+
continues to the next test case name or to the end of the section. It is
35+
an error to have something between the section headers and the first
3636
test.
3737

3838
The second column normally has keyword names. An exception to this rule
@@ -66,8 +66,8 @@ contain possible arguments to the specified keyword.
6666
like `--test 'Example *'` will actually run any test starting with
6767
:name:`Example`.
6868

69-
Settings in the Test Case table
70-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69+
Settings in the Test Case section
70+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7171

7272
Test cases can also have their own settings. Setting names are always
7373
in the second column, where keywords normally are, and their values
@@ -108,10 +108,10 @@ Example test case with settings:
108108
[Tags] dummy owner-johndoe
109109
Log Hello, world!
110110

111-
Test case related settings in the Setting table
112-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
111+
Test case related settings in the Setting section
112+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113113

114-
The Setting table can have the following test case related
114+
The Setting section can have the following test case related
115115
settings. These settings are mainly default values for the
116116
test case specific settings listed earlier.
117117

@@ -519,7 +519,7 @@ __ `HTML in error messages`_
519519
Test case name and documentation
520520
--------------------------------
521521

522-
The test case name comes directly from the Test Case table: it is
522+
The test case name comes directly from the Test Case section: it is
523523
exactly what is entered into the test case column. Test cases in one
524524
test suite should have unique names. Pertaining to this, you can also
525525
use the `automatic variable`_ `${TEST_NAME}` within the test
@@ -612,17 +612,17 @@ In this section it is only explained how to set tags for test
612612
cases, and different ways to do it are listed below. These
613613
approaches can naturally be used together.
614614

615-
`Force Tags`:setting: in the Setting table
615+
`Force Tags`:setting: in the Setting section
616616
All test cases in a test case file with this setting always get
617617
specified tags. If it is used in the `test suite initialization file`,
618618
all test cases in sub test suites get these tags.
619619

620-
`Default Tags`:setting: in the Setting table
620+
`Default Tags`:setting: in the Setting section
621621
Test cases that do not have a :setting:`[Tags]` setting of their own
622622
get these tags. Default tags are not supported in test suite initialization
623623
files.
624624

625-
`[Tags]`:setting: in the Test Case table
625+
`[Tags]`:setting: in the Test Case section
626626
A test case always gets these tags. Additionally, it does not get the
627627
possible tags specified with :setting:`Default Tags`, so it is possible
628628
to override the :setting:`Default Tags` by using empty value. It is
@@ -715,10 +715,10 @@ on by default.
715715

716716
The easiest way to specify a setup or a teardown for test cases in a
717717
test case file is using the :setting:`Test Setup` and :setting:`Test
718-
Teardown` settings in the Setting table. Individual test cases can
718+
Teardown` settings in the Setting section. Individual test cases can
719719
also have their own setup or teardown. They are defined with the
720720
:setting:`[Setup]` or :setting:`[Teardown]` settings in the test case
721-
table and they override possible :setting:`Test Setup` and
721+
section and they override possible :setting:`Test Setup` and
722722
:setting:`Test Teardown` settings. Having no keyword after a
723723
:setting:`[Setup]` or :setting:`[Teardown]` setting means having no
724724
setup or teardown. It is also possible to use value `NONE` to indicate that
@@ -732,11 +732,11 @@ a test has no setup/teardown.
732732

733733
*** Test Cases ***
734734
Default values
735-
[Documentation] Setup and teardown from setting table
735+
[Documentation] Setup and teardown from setting section
736736
Do Something
737737

738738
Overridden setup
739-
[Documentation] Own setup, teardown from setting table
739+
[Documentation] Own setup, teardown from setting section
740740
[Setup] Open Application App B
741741
Do Something
742742

@@ -802,9 +802,9 @@ functionally fully identical.
802802
As the example illustrates, it is possible to specify the
803803
template for an individual test case using the :setting:`[Template]`
804804
setting. An alternative approach is using the :setting:`Test Template`
805-
setting in the Setting table, in which case the template is applied
805+
setting in the Setting section, in which case the template is applied
806806
for all test cases in that test case file. The :setting:`[Template]`
807-
setting overrides the possible template set in the Setting table, and
807+
setting overrides the possible template set in the Setting section, and
808808
an empty value for :setting:`[Template]` means that the test has no
809809
template even when :setting:`Test Template` is used. It is also possible
810810
to use value `NONE` to indicate that a test has no template.

‎doc/userguide/src/CreatingTestData/CreatingTestSuites.rst

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,24 @@ __ `Creating test cases`_
1515
Test case files
1616
---------------
1717

18-
Robot Framework test cases `are created`__ using test case tables in
18+
Robot Framework test cases `are created`__ using test case sections in
1919
test case files. Such a file automatically creates a test suite from
2020
all the test cases it contains. There is no upper limit for how many
2121
test cases there can be, but it is recommended to have less than ten,
2222
unless the `data-driven approach`_ is used, where one test case consists of
2323
only one high-level keyword.
2424

25-
The following settings in the Setting table can be used to customize the
25+
The following settings in the Setting section can be used to customize the
2626
test suite:
2727

2828
`Documentation`:setting:
2929
Used for specifying a `test suite documentation`_
3030
`Metadata`:setting:
31-
Used for setting `free test suite metadata`_ as name-value
32-
pairs.
31+
Used for setting `free test suite metadata`_ as name-value pairs.
3332
`Suite Setup`:setting:, `Suite Teardown`:setting:
3433
Specify `suite setup and teardown`_.
3534

36-
.. note:: All setting names can optionally include a colon at the end, for
37-
example :setting:`Documentation:`. This can make reading the settings easier
38-
especially when using the plain text format.
39-
40-
.. note:: Setting names are case-insensitive, but the format used above is
41-
recommended. Settings used to be also space-insensitive, but that was
42-
deprecated in Robot Framework 3.1 and trying to use something like
43-
`M e t a d a t a` causes an error in Robot Framework 3.2.
35+
.. note:: Setting names are case-insensitive, but the format used above is recommended.
4436

4537
__ `Creating test cases`_
4638

@@ -81,7 +73,7 @@ The name format is borrowed from Python, where files named in this manner
8173
denote that a directory is a module.
8274

8375
Initialization files have the same structure and syntax as test case files,
84-
except that they cannot have test case tables and not all settings are
76+
except that they cannot have test case sections and not all settings are
8577
supported. Variables and keywords created or imported in initialization files
8678
*are not* available in the lower level test suites. If you need to share
8779
variables or keywords, you can put them into `resource files`_ that can be
@@ -127,7 +119,7 @@ initialization files is explained below.
127119
Some Keyword ${arg}
128120
Another Keyword
129121

130-
__ `Test case related settings in the Setting table`_
122+
__ `Test case related settings in the Setting section`_
131123

132124
Test suite name and documentation
133125
---------------------------------
@@ -147,7 +139,7 @@ suites :name:`Some Tests` and :name:`More Tests`, respectively, and
147139
the former is executed before the latter.
148140

149141
The documentation for a test suite is set using the :setting:`Documentation`
150-
setting in the Setting table. It can be used in test case files
142+
setting in the Setting section. It can be used in test case files
151143
or, with higher-level suites, in test suite initialization files. Test
152144
suite documentation has exactly the same characteristics regarding to where
153145
it is shown and how it can be created as `test case
@@ -168,7 +160,7 @@ Free test suite metadata
168160
------------------------
169161

170162
Test suites can also have other metadata than the documentation. This metadata
171-
is defined in the Setting table using the :setting:`Metadata` setting. Metadata
163+
is defined in the Setting section using the :setting:`Metadata` setting. Metadata
172164
set in this manner is shown in test reports and logs.
173165

174166
The name and value for the metadata are located in the columns following
@@ -204,7 +196,7 @@ initialization file`_.
204196
__ `Test setup and teardown`_
205197

206198
Similarly as with test cases, a suite setup and teardown are keywords
207-
that may take arguments. They are defined in the Setting table with
199+
that may take arguments. They are defined in the Setting section with
208200
:setting:`Suite Setup` and :setting:`Suite Teardown` settings,
209201
respectively. Keyword names and possible arguments are located in
210202
the columns after the setting name.

‎doc/userguide/src/CreatingTestData/CreatingUserKeywords.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Creating user keywords
22
======================
33

4-
Keyword tables are used to create new higher-level keywords by
4+
Keyword sections are used to create new higher-level keywords by
55
combining existing keywords together. These keywords are called *user
66
keywords* to differentiate them from lowest level *library keywords*
77
that are implemented in test libraries. The syntax for creating user
@@ -19,8 +19,8 @@ Basic syntax
1919
~~~~~~~~~~~~
2020

2121
In many ways, the overall user keyword syntax is identical to the
22-
`test case syntax`_. User keywords are created in keyword tables
23-
which differ from test case tables only by the name that is used to
22+
`test case syntax`_. User keywords are created in Keyword sections
23+
which differ from Test Case sections only by the name that is used to
2424
identify them. User keyword names are in the first column similarly as
2525
test cases names. Also user keywords are created from keywords, either
2626
from keywords in test libraries or other user keywords. Keyword names
@@ -51,8 +51,8 @@ and `test suite initialization files`_. Keywords created in resource
5151
files are available for files using them, whereas other keywords are
5252
only available in the files where they are created.
5353

54-
Settings in the Keyword table
55-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54+
Settings in the Keyword section
55+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5656

5757
User keywords can have similar settings as `test cases`__, and they
5858
have the same square bracket syntax separating them from keyword
@@ -84,16 +84,16 @@ this section.
8484
`[T a g s]` causes an error in Robot Framework 3.2. Possible spaces
8585
between brackets and the name (e.g. `[ Tags ]`) are still allowed.
8686

87-
__ `Settings in the test case table`_
87+
__ `Settings in the test case section`_
8888
__ `User keyword tags`_
8989

9090
.. _User keyword documentation:
9191

9292
User keyword name and documentation
9393
-----------------------------------
9494

95-
The user keyword name is defined in the first column of the user
96-
keyword table. Of course, the name should be descriptive, and it is
95+
The user keyword name is defined in the first column of the
96+
Keyword section. Of course, the name should be descriptive, and it is
9797
acceptable to have quite long keyword names. Actually, when creating
9898
use-case-like test cases, the highest-level keywords are often
9999
formulated as sentences or even paragraphs.

0 commit comments

Comments
 (0)