Skip to content

Commit 27e59e6

Browse files
pekkaklarckyanne
authored andcommitted
UG: Section/settings names are space-insensitive robotframework#3082
1 parent 04c826c commit 27e59e6

File tree

4 files changed

+14
-19
lines changed

4 files changed

+14
-19
lines changed

doc/userguide/src/CreatingTestData/CreatingTestCases.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,10 @@ below and explained later in this section.
9393
their own section.
9494

9595
.. note:: Setting names are case-insensitive, but the format used above is
96-
recommended. Prior to Robot Framework 3.1, settings were also
97-
space-insensitive meaning that extra spaces could be added (e.g.
98-
`[T a g s]`). This is now deprecated and only the format above,
99-
case-insensitively, is supported. Possible space between brackets
100-
and the name (e.g. `[ Tags ]`) is still allowed.
96+
recommended. Settings used to be also space-insensitive, but that was
97+
deprecated in Robot Framework 3.1 and trying to use something like
98+
`[T a g s]` causes an error in Robot Framework 3.2. Possible spaces
99+
between brackets and the name (e.g. `[ Tags ]`) are still allowed.
101100

102101
Example test case with settings:
103102

doc/userguide/src/CreatingTestData/CreatingTestSuites.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,9 @@ test suite:
3838
especially when using the plain text format.
3939

4040
.. note:: Setting names are case-insensitive, but the format used above is
41-
recommended. Prior to Robot Framework 3.1, settings were also
42-
space-insensitive meaning that spaces could be removed (e.g.
43-
`SuiteSetup`) or extra spaces added (e.g. `M e t a d a t a`). This is
44-
now deprecated and only the format above, case-insensitively, is
45-
supported.
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.
4644

4745
__ `Creating test cases`_
4846

doc/userguide/src/CreatingTestData/CreatingUserKeywords.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,10 @@ this section.
7979
in a section of their own.
8080

8181
.. note:: Setting names are case-insensitive, but the format used above is
82-
recommended. Prior to Robot Framework 3.1, settings were also
83-
space-insensitive meaning that extra spaces could be added (e.g.
84-
`[T a g s]`). This is now deprecated and only the format above,
85-
case-insensitively, is supported. Possible space between brackets
86-
and the name (e.g. `[ Tags ]`) is still allowed.
82+
recommended. Settings used to be also space-insensitive, but that was
83+
deprecated in Robot Framework 3.1 and trying to use something like
84+
`[T a g s]` causes an error in Robot Framework 3.2. Possible spaces
85+
between brackets and the name (e.g. `[ Tags ]`) are still allowed.
8786

8887
__ `Settings in the test case table`_
8988
__ `User keyword tags`_

doc/userguide/src/CreatingTestData/TestDataSyntax.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,9 @@ purposes. This is especially useful when creating test cases using the
9191

9292
Possible data before the first section is ignored.
9393

94-
.. note:: Prior to Robot Framework 3.1, section names were space-insensitive,
95-
meaning that spaces could be removed (e.g. `TestCases`) or extra
96-
spaces added (e.g. `S e t t i n g s`). This is now deprecated and
97-
only the format in the table above, case-insensitively, is supported.
94+
.. note:: Section names used to be space-insensitive, but that was deprecated
95+
in Robot Framework 3.1 and trying to use something like `TestCases`
96+
or `S e t t i n g s` causes an error in Robot Framework 3.2.
9897

9998
.. note:: Prior to Robot Framework 3.1, all unrecognized sections were silently
10099
ignored but nowadays they cause an error. `Comments` sections can

0 commit comments

Comments
 (0)