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
We currently support both plural and singular forms with sections headers so that both
*** Test Cases ***Example
Log Message
and
*** Test Case ***Example
Log Message
are valid.
The plural form is used a lot more widely. The main reason the singular form has ever been supported than in the early days Robot's data was in HTML tables and tables typically had headers like in this example:
Test Case
Keyword
Argument
Argument
Example
Log
Message
Nowadays there are no concrete benefits in supporting both header formats. There are, however, some drawbacks:
Supporting multiple formats like this makes the overall syntax a bit more complicated to learn and for external tools to support.
Adding support for the dual form wouldn't be a big task, but it would make the overall syntax even more complicated. A much simpler solution is supporting only the plural form. We can consider the section header like Test Cases to indicate that "below this header we have tests" and it works fine regardless how many tests there actually are. We have thus made a decision to:
remove the support for singular form with English.
We obviously cannot just remove the support of singular headers in RF 5.1 because the change would be backwards incompatible. These are the steps we are planning to take instead:
Document that singular headers are deprecated in RF 5.1 release notes and in the User Guide. No visible deprecation warning yet. This is covered by this issue.
Start emitting deprecation warnings. This can earliest be done in RF 6.0, but we don't have too big hurry and waiting for 7.0 might be better. This is covered by Loudly deprecate singular section headers #4432.
Actually remove the support for singular headers. This can earliest be the next major release after the one where they are visibly deprecated.
The text was updated successfully, but these errors were encountered:
We currently support both plural and singular forms with sections headers so that both
and
are valid.
The plural form is used a lot more widely. The main reason the singular form has ever been supported than in the early days Robot's data was in HTML tables and tables typically had headers like in this example:
Nowadays there are no concrete benefits in supporting both header formats. There are, however, some drawbacks:
Adding support for the dual form wouldn't be a big task, but it would make the overall syntax even more complicated. A much simpler solution is supporting only the plural form. We can consider the section header like
Test Cases
to indicate that "below this header we have tests" and it works fine regardless how many tests there actually are. We have thus made a decision to:We obviously cannot just remove the support of singular headers in RF 5.1 because the change would be backwards incompatible. These are the steps we are planning to take instead:
The text was updated successfully, but these errors were encountered: