Fix typo in parameter description attribute #3607
Merged
Conversation
This file contains 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
When the `store-type` parameter was added in b402e2f for #3548, it looks like the `@deprecated` attribute name may have been chosen from an IDE autocompletion process instead of the `@desc` attribute that provides the parameter description. This commit fixes the attribute name, so the description will appear in the docs at <https://www.dita-ot.org/dev/parameters/parameters-base.html#base__store-type>. Signed-off-by: Roger Sheen <roger@infotexture.net>
Information about default values is appended to the parameter description in the documentation, so it's important that each description is a complete sentence. Signed-off-by: Roger Sheen <roger@infotexture.net>
jelovirt
approved these changes
Oct 12, 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
When the
store-typeparameter was added in b402e2f for #3548, it looks like the@deprecatedattribute name may have been chosen from an IDE autocompletion process instead of the@descattribute that provides the parameter description.Motivation and Context
This commit fixes the attribute name, so the (currently missing) description will appear in the parameter documentation at
https://www.dita-ot.org/dev/parameters/parameters-base.html#base__store-type.
How Has This Been Tested?
✅ Built site output locally, parameter description is shown.
Type of Changes
Documentation and Compatibility