Fix misleading component key documentation about the name key being inheritable #13
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.
In the "Components" section of the configuration documentation, it is made clear that the
name
key is not meant to be defined directly from components:And indeed, it is not possible to define a field with just a
component
key, so trying to inherit the name that would have been defined by the component itself throws an error in the cms. The fact that the name key is always required for all fields is also made clear in the "Fields" section:But the description about the
component
key is misleading as it implies that thename
key can be inherited from components: