Skip to content
This repository has been archived by the owner on Dec 21, 2024. It is now read-only.

Add "Pringles" style note for using Rule keyword in Gherkin #561

Open
luke-hill opened this issue Dec 10, 2020 · 4 comments
Open

Add "Pringles" style note for using Rule keyword in Gherkin #561

luke-hill opened this issue Dec 10, 2020 · 4 comments
Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@luke-hill
Copy link
Contributor

Once you pop you just can't stop.

When using a Rule keyword in Gherkin, you cannot then "un-use" it, i.e. the following is not semantically possible (Nor will it ever likely be).

Feature: A
  Background:
    Given whatever
  Rule: One
    # many scenarios
  Rule: Two
    # many scenarios
  Scenario: Standalone Scenario

A User should either make the Standalone scenario part of a new Rule and call it Rule: Other stuff or alternatively alter the structure of their gherkin document like so

Feature: A
  Background:
    Given whatever
  Scenario: Standalone Scenario
  Rule: One
    # many scenarios
  Rule: Two
    # many scenarios
@aslakhellesoy aslakhellesoy added the 🍼 incomplete Blocked until more information is provided label Apr 26, 2021
@aslakhellesoy
Copy link
Contributor

What are you suggesting here @luke-hill ?

@luke-hill
Copy link
Contributor Author

Updating the docs stating "how" Rules should be used and how you should structure your feature files. To avoid this scenario where you can't "un-use" a rule.

@mattwynne
Copy link
Member

Go for it Luke! Do you want some feedback on your intended changes to the copy?

@luke-hill
Copy link
Contributor Author

I'll pop a PR in first, and tag you and some of the others. So long as we're happy with my analogy. Also I know we try to steer clear of "This is correct", and just say "This is incorrect", but in this instance I really think my 2 options are the "only" correct ones.

@luke-hill luke-hill added good first issue Good for newcomers 📖 documentation Improvements or additions to documentation and removed 🍼 incomplete Blocked until more information is provided labels Jul 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📖 documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants