This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Issue-2916- Provide more info about file/classes in code snippets to adding-attributes.html #8218
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: Zilker Technology
partners-contribution
BarnyShergold
suggested changes
Nov 12, 2020
| @@ -186,6 +188,8 @@ For scalar attributes we can use next configuration: | |||
| </config> | |||
| ``` | |||
|
|
|||
| Here, the scalar attributes indicate the simple form of attribute representation such as an Integer or a String. The class or interface for which the extension attributes must be added is specified inside the "for" attribute of the `<extension_attributes>` tag. In this case, it is the ProductInterface. The attribute is specified with an unique code and it's type. | |||
There was a problem hiding this comment.
(a unique is correct as unique starts with a consonant sound)
Suggested change
| Here, the scalar attributes indicate the simple form of attribute representation such as an Integer or a String. The class or interface for which the extension attributes must be added is specified inside the "for" attribute of the `<extension_attributes>` tag. In this case, it is the ProductInterface. The attribute is specified with an unique code and it's type. | |
| Here, the scalar attributes indicate the simple form of attribute representation such as an Integer or a String. The class or interface for which the extension attributes must be added is specified inside the "for" attribute of the `<extension_attributes>` tag. In this case, it is the ProductInterface. The attribute is specified with a unique code and its type. |
| @@ -206,6 +212,8 @@ For array extension attributes: | |||
| </config> | |||
| ``` | |||
|
|
|||
| The array extension attributes are just an extension of the scalar attributes where a range of values can be represented as an attribute. `[]` symbol is used to indicate the type of the attribute as array. | |||
There was a problem hiding this comment.
Suggested change
| The array extension attributes are just an extension of the scalar attributes where a range of values can be represented as an attribute. `[]` symbol is used to indicate the type of the attribute as array. | |
| The array extension attributes are just an extension of the scalar attributes where a range of values can be represented as an attribute. The `[]` symbol is used to indicate the type of the attribute as an array. |
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: ready for review
labels
|
Hi @BarnyShergold , I went through the https://devdocs.magento.com/guides/v2.4/extension-dev-guide/extension_attributes/adding-attributes.html page and after I got an understanding of the issue specified, I made these changes. I don't know how to proceed hereafter. I would like to have some suggestions. Can you assist me with this? |
|
@shrielenee - Some additional information to the section on your issue has been added by @dineshvb - Textually the additions are fine, can you take a look and feedback as to if there is enough new information or what might else be needed to clarify the examples as indicated in you report? |
keharper
suggested changes
Nov 17, 2020
| @@ -175,6 +175,8 @@ Now we need to bind our plugin to `ProductInterface`: | |||
|
|
|||
| ## Extension Attributes Configuration: | |||
|
|
|||
| The file which holds these extension attributes must reside under the /etc folder of your module. | |||
There was a problem hiding this comment.
Suggested change
| The file which holds these extension attributes must reside under the /etc folder of your module. | |
| The file that holds these extension attributes must reside under the `/etc` folder of your module. |
There was a problem hiding this comment.
Change line 180 to "For scalar attributes, we can use the following configuration:"
| @@ -186,6 +188,8 @@ For scalar attributes we can use next configuration: | |||
| </config> | |||
| ``` | |||
|
|
|||
| Here, the scalar attributes indicate the simple form of attribute representation such as an Integer or a String. The class or interface for which the extension attributes must be added is specified inside the "for" attribute of the `<extension_attributes>` tag. In this case, it is the ProductInterface. The attribute is specified with a unique code and its type. | |||
There was a problem hiding this comment.
Suggested change
| Here, the scalar attributes indicate the simple form of attribute representation such as an Integer or a String. The class or interface for which the extension attributes must be added is specified inside the "for" attribute of the `<extension_attributes>` tag. In this case, it is the ProductInterface. The attribute is specified with a unique code and its type. | |
| Here, the scalar attributes indicate the simple form of attribute representation, such as an integer or a string. Specify the class or interface of the extension attributes inside the "for" attribute of the `<extension_attributes>` tag. In this case, it is the ProductInterface. The attribute is specified with a unique code and its type. |
| @@ -206,6 +212,8 @@ For array extension attributes: | |||
| </config> | |||
| ``` | |||
|
|
|||
| The array extension attributes are just an extension of the scalar attributes where a range of values can be represented as an attribute. The `[]` symbol is used to indicate the type of the attribute as an array. | |||
There was a problem hiding this comment.
Suggested change
| The array extension attributes are just an extension of the scalar attributes where a range of values can be represented as an attribute. The `[]` symbol is used to indicate the type of the attribute as an array. | |
| The array extension attributes are just an extension of the scalar attributes where a range of values can be represented as an attribute. The `[]` symbol indicates the attribute type is an array. |
dineshvb
force-pushed
the
issue-2916-info-about-adding-attributes.html
branch
from
3bb235a to
0a232d6
Compare
|
@keharper @BarnyShergold @dobooth Changed the base to master |
|
Agree with all @keharper comments. Thanks y'all! |
|
@shrielenee As @BarnyShergold said, I would like feedback on my changes so that I could proceed further |
|
Looks good so far. |
BarnyShergold
approved these changes
Nov 27, 2020
m2-community-project
bot
added
Progress: approved
and removed
Progress: changes requested
labels
keharper
approved these changes
Nov 27, 2020
|
running tests |
|
Hi @dineshvb, thank you for your contribution! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Purpose of this pull request
This pull request (PR) fixes #2916
Affected DevDocs pages