Skip to content

Commit f09188e

Browse files
committed
Results annotation
1 parent a0b1bbf commit f09188e

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

docs/05-annotations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Use annotations in [meta](/docs/meta) and avoid them in features where possible.
3535
| [`@Parallel`](/docs/parallel#parallel-scenario-outline-examples) | Examples | [v3.69.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.69.0) | Executes expanded examples in outlines in parallel |
3636
| [`@Timeout`](/docs/locator-level-timeouts#timeout-annotations) | Step | [v3.73.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.73.0) | Specifies a timeout period on a [wait](/docs/dsl#sleeps-and-waits), [until/while](/docs/dsl#untilwhile), [for each](/docs/dsl#foreach), [assertion](/docs/dsl#assertions) or [locator](/docs/dsl#element-locators) DSL step. Examples: `@Timeout('10s')`, `@Timeout('2m30s')`, `@Timeout('2m')` |
3737
| [`@Delay`](/docs/locator-level-timeouts#delay-annotation) | Step | [v3.73.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.73.0) | Specifies a delay interval on a [wait](/docs/dsl#sleeps-and-waits), [until/while](/docs/dsl#untilwhile) DSL step. Examples: `@Delay('2s')`, `@Delay('1s500ms')`, `@Delay('1m')` |
38-
| [`@Results`](/docs/reports/csv#results-annotation) | Feature<br/>Scenario<br/>StepDef<br/>Scenario Outline<br/>Examples | [v3.77.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0) | Generates CSV results for a gherkin node |
38+
| [`@Results`](/docs/reports/csv#results-annotation) | Feature<br/>Rule</b>Scenario<br/>StepDef<br/>Scenario Outline<br/>Examples | [v3.77.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.77.0) | Generates CSV results for a gherkin node |
3939
| `@Trim` | Step | [v3.62.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.62.0) | Trims strings when performing comparison operations |
4040
| `@IgnoreCase` | Step | [v3.62.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v3.62.0) | Ignores case when performing comparison operations |
4141
| `@Ignore` | Feature<br/>Scenario<br/>Rule<br/>Background<br/>Examples | [v1.0.0](https://github.com/gwen-interpreter/gwen-web/releases/tag/v1.0.0) | Ignores and skips over a Gherkin block/node to avoid evaluation |

docs/12-reports/03-csv.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ Where:
6262
<li><code>Feature</code> - To log the results of all features to the CSV file as they complete</li>
6363
<li><code>Rule</code> - To log the results of all rules to the CSV file as they complete</li>
6464
<li><code>Scenario</code> - To log the results of all scenarios to the CSV file as they complete</li>
65+
<li><code>Examples</code> - To log the results of all examples to the CSV file as they complete</li>
6566
<li><code>StepDef</code> - To log the results of all <Link to="/docs/meta#stepdefs">StepDefs</Link> to the CSV file as they complete</li>
66-
<li>Or blank to not log any results automatically for when you want explicitly manage CSV logging yourself through a [`@Results`](#results-annotation) annotation</li>
67+
<li>Or blank to not log any results automatically; for when you want to explicitly control where the logging will occur with a [`@Results`](#results-annotation) annotation</li>
6768
</ul>
6869
</li>
6970
<li>
@@ -619,7 +620,7 @@ In this configuration, fields are replicated across file definitions (note: fiel
619620

620621
## Results Annotation
621622

622-
Used to log results to a file at a specific Feature, Scenario, StepDef, Scenaro Outline, or Examples node level.
623+
Used to log results to a file at a specific Feature, Rule, Scenario, StepDef, Scenaro Outline, or Examples node level.
623624

624625
### Syntax:
625626

0 commit comments

Comments
 (0)