Skip to content

Adding deprecation attribute info #572

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

Merged
merged 7 commits into from
Feb 4, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,7 @@ Attributes|Type|Use|Description
---|---|---|---
`key`|string|optional|Key attribute of data/value pair.
`unique`|enum: `"prefix"`, `"suffix"`|optional|Add suite or test wide unique sequence as "prefix" or "suffix" to the data value if specified.
`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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move this to entity tag description


### var {#var-tag}

Expand Down
2 changes: 2 additions & 0 deletions docs/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ Attributes|Type|Use|Description
`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.
`parameterized`|boolean |optional|Include and set to `"true"` if the `url` for this page has parameters that need to be replaced for proper use.
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.
`deprecated`|string|optional|Used to warn about the future deprecation of the page. String will appear in Allure reports and console output at runtime.

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

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

Attributes|Type|Use|Description
---|---|---|---
`deprecated`|string|optional|Used to warn about the future deprecation of the section. String will appear in Allure reports and console output at runtime.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Section reference in page do not have deprecated attr
It is only available under Section entity.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this from Page doc. This attr not exist here.

`name`|string|required|Unique section name identifier.
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.

Expand Down
2 changes: 2 additions & 0 deletions docs/section.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ The following is an example of a call in test:
Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Unique section name identifier.
`deprecated`|string|optional|Used to warn about the future deprecation of the section. String will appear in Allure reports and console output at runtime.
`remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing.

### element {#element-tag}
Expand All @@ -103,6 +104,7 @@ Attributes|Type|Use|Description
`locatorFunction`|string|optional|[Locator function][] declaration to be used in lieu of a selector.
`timeout`|string|optional|The timeout after interaction with the element (in seconds). The default is _none_.
`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][].
`deprecated`|string|optional|Used to warn about the future deprecation of the element. String will appear in Allure reports and console output at runtime.
`remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing.

#### `timeout` attribute {#timeout-attribute}
Expand Down
1 change: 0 additions & 1 deletion docs/section/locator-functions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Locator functions


## Define Locator::functions in elements

Codeception has a set of very useful [Locator functions][] that may be used by elements inside a [section][].
Expand Down
1 change: 1 addition & 0 deletions docs/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Attribute|Type|Use|Description
`remove`|boolean|optional|Set `true` to remove the test when merging.
`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`.
`insertAfter`|string|optional| Set `stepKey` of the test step after which you want to insert the test when [merging].
`deprecated`|string|optional|Used to warn about the future deprecation of the test. String will appear in Allure reports and console output at runtime.
`extends`|string|optional|A name of the parent test to [extend].

`<test>` may also contain [`<annotations>`], [`<before>`], [`<after>`], any [action][actions], or [`<actionGroup>`].
Expand Down
1 change: 1 addition & 0 deletions docs/test/action-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@ Attribute|Type|Use|Description
---|---|---|---
`name`|string|required|Identifier of the action group.
`extends`|string|optional|Identifies the action group to extend.
`deprecated`|string|optional|Used to warn about the future deprecation of the actionGroup. String will appear in Allure reports and console output at runtime.

It may contain `<arguments>`.

Expand Down