Data entity document improvement #693
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
magento-engcom-team
added
Partner: Ziffity
partners-contribution
dobooth
suggested changes
May 11, 2020
docs/data.md
Outdated
| @@ -32,6 +48,12 @@ In this example: | |||
| * `MAGENTO_ADMIN_USERNAME` is a name of an environment variable. | |||
| The corresponding value will be assigned to `userInput` as a result. | |||
|
|
|||
| The following is the usage of `_ENV` in the `Magento/Braintree/Test/Mftf/ActionGroup/AdminDeleteRoleActionGroup.xml` action group: | |||
There was a problem hiding this comment.
"The following is an example of the usage of..."
Same with L72 and L96.
There was a problem hiding this comment.
@dobooth Updated the changes.
docs/data.md
Outdated
| @@ -107,7 +145,7 @@ userInput="We'll email you an order confirmation with details and tracking info. | |||
|
|
|||
| ## Format | |||
|
|
|||
| The format of `<data>` is: | |||
| The format of `<data>` entity is: | |||
There was a problem hiding this comment.
"The format of the data...
There was a problem hiding this comment.
@dobooth Updated the changes.
docs/data.md
Outdated
| @@ -205,7 +243,7 @@ You can also call data from the xml definition of a `data` tag directly: | |||
|
|
|||
| Attributes|Type|Use|Description | |||
| ---|---|---|--- | |||
| `name`|string|optional|Name of the `<entity>`. | |||
| `name`|string|optional|Name of the `<entity>`. Camel case is used for the entity name. | |||
There was a problem hiding this comment.
"Use camel case for entity names."
There was a problem hiding this comment.
@dobooth Updated the changes. Please review it.
docs/data.md
Outdated
| @@ -231,6 +275,12 @@ Attributes|Type|Use|Description | |||
| `entityKey`|string|optional|Key attribute of the referenced entity from which to get a value. | |||
| `unique`|--|--|*This attribute hasn't been implemented yet.* | |||
|
|
|||
| Example: | |||
|
|
|||
| ``` | |||
There was a problem hiding this comment.
Use xml as the codeblock type.
There was a problem hiding this comment.
@dobooth This has been done. Please review it.
dobooth
approved these changes
May 19, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Improved the Data entity MFTF document by providing examples for each data entity node.
Added example from the already defined MFTF test for each sub-topic.
Affected Pages
Contribution checklist