mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-22 03:53:59 -07:00
An earlier optimization of ansible-doc -l caused failures. (#47012)
* An earlier optimization of ansible-doc -l caused failures. The optimization quickly searches the plugin code for short_description fields and then uses that in the -l output. The searching was a bit too naive and ended up pulling out malformed yaml. This caused those plugins to be omitted from the list of plugins of that type with a warning that their documentation strings were wrong. This change makes the documentation parser aware that the documentation string could have a relative indent for all of its fields which makes it robust in the face of this particular problem. * Don't search for space after short_description: Any whitespace would be valid. In particular newline
This commit is contained in:
parent
0272fd4b37
commit
61ae6424a3
2 changed files with 22 additions and 8 deletions
3
changelogs/fragments/plugin-docs-list-fix.yaml
Normal file
3
changelogs/fragments/plugin-docs-list-fix.yaml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
---
|
||||
bugfixes:
|
||||
- 'Fixed an issue with ansible-doc -l failing when parsing some plugin documentation.'
|
||||
Loading…
Add table
Add a link
Reference in a new issue