Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Deprecate using singular section headers #4431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pekkaklarck opened this issue Aug 15, 2022 · 0 comments
Closed

Deprecate using singular section headers #4431

pekkaklarck opened this issue Aug 15, 2022 · 0 comments

Comments

@pekkaklarck
Copy link
Member

pekkaklarck commented Aug 15, 2022

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:

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:

  1. 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.
  2. 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.
  3. Actually remove the support for singular headers. This can earliest be the next major release after the one where they are visibly deprecated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant