Docs - render object choices #4442
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
github-actions
bot
added
backport-4.7
| {legends[c] ? ( | ||
| <> | ||
| {' - '} | ||
| {legends[c]} |
There was a problem hiding this comment.
legends[c] can be either a string or a list of strings (if it's something else it is broken), and it can contain Ansible markup.
I would probably normalize it to arrays in parseOptions, and do something like
{legends[c].map((d) => (
<p>{this.applyDocFormatters(d)}</p>
))}
with it. Or maybe (to avoid strange formatting) don't add <p>, and replace </p> by <br>? 🤷
previously, `choices` was a list of options, now it can also be an object of options: description, where description can be a string or an array of strings No-Issue
…ltiline description
|
@felixfontein can you re-check please?
I updated choices to monospace the value, and show the potentially multiline (& formatted) description after. |
Co-authored-by: Felix Fontein <[email protected]>
felixfontein
reviewed
Nov 3, 2023
felixfontein
approved these changes
Nov 3, 2023
This comment was marked as outdated.
This comment was marked as outdated.
Backport to stable-4.8: 💚 backport PR created✅ Backport PR branch: Backported as #4489 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Nov 5, 2023
* RenderPluginDoc - support `choices` as an object previously, `choices` was a list of options, now it can also be an object of options: description, where description can be a string or an array of strings No-Issue * PAUSED: Use `git resume` to continue working. [skip ci] * Choice, Legend - render a monospace choice name, and a potentially multiline description * also fix docs error rendering * Update src/components/render-plugin-doc/render-plugin-doc.tsx Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 269af3f)
himdel
added a commit
to himdel/ansible-hub-ui
that referenced
this pull request
Nov 5, 2023
* RenderPluginDoc - support `choices` as an object previously, `choices` was a list of options, now it can also be an object of options: description, where description can be a string or an array of strings No-Issue * PAUSED: Use `git resume` to continue working. [skip ci] * Choice, Legend - render a monospace choice name, and a potentially multiline description * also fix docs error rendering * Update src/components/render-plugin-doc/render-plugin-doc.tsx Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 269af3f)
himdel
added a commit
that referenced
this pull request
Nov 6, 2023
* RenderPluginDoc - support `choices` as an object previously, `choices` was a list of options, now it can also be an object of options: description, where description can be a string or an array of strings No-Issue * PAUSED: Use `git resume` to continue working. [skip ci] * Choice, Legend - render a monospace choice name, and a potentially multiline description * also fix docs error rendering * Update src/components/render-plugin-doc/render-plugin-doc.tsx Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 269af3f)
himdel
added a commit
that referenced
this pull request
Nov 6, 2023
* RenderPluginDoc - support `choices` as an object previously, `choices` was a list of options, now it can also be an object of options: description, where description can be a string or an array of strings No-Issue * PAUSED: Use `git resume` to continue working. [skip ci] * Choice, Legend - render a monospace choice name, and a potentially multiline description * also fix docs error rendering * Update src/components/render-plugin-doc/render-plugin-doc.tsx Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit 269af3f) Co-authored-by: Martin Hradil <[email protected]>
himdel
added
backported-4.7
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.
ansible/ansible#81951 (comment)
In docs renderer,
choicesused to be an array of string values, that's still permissible,but now we also accept an object of
{ value: description }instead of the array.This also changes the rendering of choices to be closer to https://docs.ansible.com/ansible/devel/collections/ansible/builtin/config_lookup.html#parameter-on_missing
=> monospace the choice value, "
value: description"Before - Array:
Before - Object:
Now - Array:
Now - Object:
(also fixed the error message...
)