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

Conversation

dobooth
Copy link
Contributor

@dobooth dobooth commented Feb 3, 2020

Description

This PR adds information about the new deprecation tag.

Fixed Issues (if relevant)

  1. https://jira.corp.magento.com/browse/MQE-1983

Contribution checklist

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/verification tests (if applicable)
  • All automated tests passed successfully (all builds on Travis CI are green)
  • Changes to Framework doesn't have backward incompatible changes for tests or have related Pull Request with fixes to tests

@dobooth dobooth added the DOC label Feb 3, 2020
@dobooth dobooth self-assigned this Feb 3, 2020
@coveralls
Copy link

coveralls commented Feb 3, 2020

Coverage Status

Coverage remained the same at 50.994% when pulling 96413c4 on magento-devdocs:db_deprecation into c589521 on magento:master.

@okolesnyk okolesnyk self-requested a review February 3, 2020 16:19
@okolesnyk
Copy link
Member

Copy link
Member

@okolesnyk okolesnyk left a comment

Choose a reason for hiding this comment

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

Please check my comments

docs/page.md Outdated
@@ -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.

docs/data.md Outdated
@@ -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

@dobooth dobooth requested a review from okolesnyk February 3, 2020 16:52
Copy link
Member

@okolesnyk okolesnyk left a comment

Choose a reason for hiding this comment

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

2 small comments

  1. please add deprecation attr to https://github.com/magento/magento2-functional-testing-framework/blob/develop/docs/metadata.md#operation-operation-tag
  2. Remove deprecated attr from page.md file under section tag

@dobooth dobooth requested a review from okolesnyk February 4, 2020 17:29
@okolesnyk okolesnyk merged commit d7efde8 into magento:master Feb 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants