Update baredoc to dump docstrings like sys.doc #56902
Merged
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.
What does this PR do?
Improves the recently merged baredoc to support display of module and module.function docstrings like sys.doc. Leverages the same formatting util as sys.doc to generate the same output, only baredoc does not require the state or execution module to be loadable by salt. Thus, it is useful in situations when you need docs for modules which cannot be loaded on the current machine. Or to export docstrings in bulk.
What issues does this PR fix or reference?
None
Previous Behavior
Docstrings not suppored by baredoc
New Behavior
(zpool module is not loadable on this machine)
Merge requirements satisfied?
[NOTICE] Bug fixes or features added to Salt require tests.
Commits signed with GPG?
No