Where exactly does the "# title-format:" comment go? Lint still warns after I added one

Example threads. These questions and answers were written by the SDODS team to document real problems and how to fix them. The people named are illustrative, not real users. Questions asked on this site are marked new.

Trying to clear this:

text

⚠ features/auth/login.feature:15  outline/title-format  Scenario Outline has no "# title-format:" comment; examples will be titled "Example #N".

I added the comment and the warning did not move. My file:

gherkin

# title-format: <username> → <error>

@ui @regression
Scenario Outline: Failed login shows a clear error
  When I login with "<username>" and "<password>"
  Then I should see the login error "<error>"

  Examples:
    | username        | password     | error                                   |
    | locked_out_user | secret_sauce | Sorry, this user has been locked out.   |
    | standard_user   | wrong        | Username and password do not match      |

Does it have to be in a particular place?

lint data-driven

asked by Chandra Pillai

3 answers

Accepted answer
Yes. The comment is only picked up if it sits inside the outline's own span — from two lines above the Scenario Outline: keyword down to the last row of the last Examples: table. Yours is three lines up, above the tag line, so it falls one line outside the window and belongs to nothing.
Put it directly above Examples:, which is also where it reads best:
gherkin
```
@ui @regression
Scenario Outline: Failed login shows a clear error
  When I login with "<username>" and "<password>"
  Then I should see the login error "<error>"

  # title-format: <username> → <error>
  Examples:
    | username        | password     | error                                   |
    | locked_out_user | secret_sauce | Sorry, this user has been locked out.   |
    | standard_user   | wrong        | Username and password do not match      |
```
The match is case-insensitive and tolerates missing space after the hash, so #Title-Format: also counts — but the position is not negotiable.
answered by Lena Hartwig
It is worth doing rather than suppressing. Without the comment, a failing row is reported as Example #3 and you have to open the feature file and count table rows to find out which data broke. With it, the failure reads locked_out_user → Sorry, this user has been locked out. and the report tells you the answer.
The placeholders are the column names in angle brackets, same as in the steps, and you can put literal text around them.
answered by Renata Kohl
Late addition for anyone who finds this while cleaning up an old project: it is a warning, so it never blocks a run — unless somebody has --strict in the pipeline, in which case all warnings become exit 3 and this is usually the one that trips first.
answered by Priya VenkateshSDODS team

Know the answer?

Wrap commands and output in triple backticks and they will render as a code block.

Checking whether you’re signed in…

Have a different question? Ask it.

Where exactly does the "# title-format:" comment go? Lint still warns after I added one

3 answers

Know the answer?

Related