Skip to content

Commit c8bb2de

Browse files
committed
Adding deprecation attribute info
1 parent c589521 commit c8bb2de

File tree

6 files changed

+7
-1
lines changed

6 files changed

+7
-1
lines changed

docs/data.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ Attributes|Type|Use|Description
208208
---|---|---|---
209209
`key`|string|optional|Key attribute of data/value pair.
210210
`unique`|enum: `"prefix"`, `"suffix"`|optional|Add suite or test wide unique sequence as "prefix" or "suffix" to the data value if specified.
211+
`deprecated`|string|optional|Used to warn about the future deprecation of the data entity. String will appear in Allure reports and console output at runtime.
211212

212213
### var {#var-tag}
213214

docs/page.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ Attributes|Type|Use|Description
145145
`area`|string|required|The area where this page lives. Three possible values: `admin` prepends `BACKEND_NAME` to `url`, `storefront` does not prepend anything to `url`, `external` flags the page for use with `amOnUrl`. The `url` provided must be a full URL, such as `http://myFullUrl.com/`, instead of the URL for a Magento page.
146146
`parameterized`|boolean |optional|Include and set to `"true"` if the `url` for this page has parameters that need to be replaced for proper use.
147147
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.
148+
`deprecated`|string|optional|Used to warn about the future deprecation of the page. String will appear in Allure reports and console output at runtime.
148149

149150
`<page>` may contain several [`<section>`] elements.
150151

@@ -157,6 +158,7 @@ A section is a reusable piece or part of a page.
157158

158159
Attributes|Type|Use|Description
159160
---|---|---|---
161+
`deprecated`|string|optional|Used to warn about the future deprecation of the section. String will appear in Allure reports and console output at runtime.
160162
`name`|string|required|Unique section name identifier.
161163
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.
162164

docs/section.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ The following is an example of a call in test:
8989
Attributes|Type|Use|Description
9090
---|---|---|---
9191
`name`|string|required|Unique section name identifier.
92+
`deprecated`|string|optional|Used to warn about the future deprecation of the section. String will appear in Allure reports and console output at runtime.
9293
`remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing.
9394

9495
### element {#element-tag}
@@ -103,6 +104,7 @@ Attributes|Type|Use|Description
103104
`locatorFunction`|string|optional|[Locator function][] declaration to be used in lieu of a selector.
104105
`timeout`|string|optional|The timeout after interaction with the element (in seconds). The default is _none_.
105106
`parameterized`|boolean|optional|Include and set to `true` if the `selector` for this element has parameters that need to be replaced for proper use. Learn more in [Parameterized selectors][].
107+
`deprecated`|string|optional|Used to warn about the future deprecation of the element. String will appear in Allure reports and console output at runtime.
106108
`remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing.
107109

108110
#### `timeout` attribute {#timeout-attribute}

docs/section/locator-functions.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Locator functions
22

3-
43
## Define Locator::functions in elements
54

65
Codeception has a set of very useful [Locator functions][] that may be used by elements inside a [section][].

docs/test.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ Attribute|Type|Use|Description
7373
`remove`|boolean|optional|Set `true` to remove the test when merging.
7474
`insertBefore`|string|optional| This option is used for [merging]. It enables you to add all test actions contained in the original test into a test with the same name BEFORE the test step with `stepKey` that you assigned in `insertBefore`.
7575
`insertAfter`|string|optional| Set `stepKey` of the test step after which you want to insert the test when [merging].
76+
`deprecated`|string|optional|Used to warn about the future deprecation of the test. String will appear in Allure reports and console output at runtime.
7677
`extends`|string|optional|A name of the parent test to [extend].
7778

7879
`<test>` may also contain [`<annotations>`], [`<before>`], [`<after>`], any [action][actions], or [`<actionGroup>`].

docs/test/action-groups.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,7 @@ Attribute|Type|Use|Description
255255
---|---|---|---
256256
`name`|string|required|Identifier of the action group.
257257
`extends`|string|optional|Identifies the action group to extend.
258+
`deprecated`|string|optional|Used to warn about the future deprecation of the actionGroup. String will appear in Allure reports and console output at runtime.
258259

259260
It may contain `<arguments>`.
260261

0 commit comments

Comments
 (0)