ansible-doc: export has_action when --json is used #72359
Merged
+17
−14
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
felixfontein
added a commit
to felixfontein/antsibull-build
that referenced
this pull request
Oct 27, 2020
felixfontein
added a commit
to felixfontein/antsibull-build
that referenced
this pull request
Oct 27, 2020
|
This would help users who needed the details of action plugins when they need them. Thanks @felixfontein. |
bcoca
approved these changes
Oct 27, 2020
ansibot
added
affects_2.11
core_review
abadger
reviewed
Oct 27, 2020
…at_plugin_doc and the functions it calls anyway.
|
Looks good! +1 |
ansibot
added
shipit
|
Corresponding antsibull change: ansible-community/antsibull-build#206 |
bcoca
removed
the
needs_triage
bcoca
reviewed
Oct 29, 2020
| else: | ||
| doc['action'] = False | ||
|
|
||
| doc['now_date'] = datetime.date.today().strftime('%Y-%m-%d') |
There was a problem hiding this comment.
You mean now_date and docuri? Because they are not used at all. In this code-path, they are only passed to get_snippet_text and get_man_text:
get_snippet_textuses onlyshort_description,moduleandoptions.get_man_textexplicitly ignores them as they are inDocCLI.IGNORE.
(Besides that, what the code does with docuri is strange and will probably fail if that key is ever encountered, since doc[plugin_type] usually results in a KeyError nowadays.)
felixfontein
added a commit
to felixfontein/ansible
that referenced
this pull request
Oct 30, 2020
* ansible-doc: export has_action when --json is used. * Remove docuri and now_data, which were not used resp. ignored in format_plugin_doc and the functions it calls anyway. * Add function _combine_plugin_doc. (cherry picked from commit 4fb336c)
felixfontein
added a commit
to felixfontein/ansible
that referenced
this pull request
Oct 30, 2020
* ansible-doc: export has_action when --json is used. * Remove docuri and now_data, which were not used resp. ignored in format_plugin_doc and the functions it calls anyway. * Add function _combine_plugin_doc. (cherry picked from commit 4fb336c)
This was referenced Oct 30, 2020
felixfontein
added a commit
to felixfontein/antsibull-build
that referenced
this pull request
Nov 2, 2020
felixfontein
added a commit
to felixfontein/antsibull-build
that referenced
this pull request
Nov 2, 2020
felixfontein
added a commit
to felixfontein/antsibull-build
that referenced
this pull request
Nov 2, 2020
abadger
pushed a commit
to ansible-community/antsibull-build
that referenced
this pull request
Nov 3, 2020
* Add new doc parsing backend script which more efficiently dumps all necessary data about collections and plugin docs. * Use new script instead of ansible-doc. * Make sure that proper JSON serialization is used. * Make doc parsing backend configurable. * Improve filtering. * Equivalent to ansible/ansible#72359. * Change default backend to ansible-internal.
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.
SUMMARY
Improve feature parity between
ansible-docandansible-doc --json. Needed to include this information in the docs build.ISSUE TYPE
COMPONENT NAME
ansible-doc