-
Notifications
You must be signed in to change notification settings - Fork 23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
various inline docs are not valid YAML #108
Comments
The problem is that we have the following line in the docs:
This is not valid YAML because it interprets "Note: foo" as a key-value pair. We should change that to "Note," instead and add a CI job that runs ansible-doc for every module. |
Many of the other modules do not have valid YAML. I'll add tests for this as part of the upcoming integration test for the Ansible Collection (#107) |
#109 fixes the YAML syntax errors across all the modules. |
#110 adds an integration test to validate each module's YAML syntax going forward. |
ansible-doc
crashes when we install the Ansible Collection and then try to read the inline docs forkoji_tag
.Steps to reproduce:
This is just a yaml.scanner.ScannerError backtrace from PyYAML, not the full backtrace from
ansible-doc
. The crash is inansible/parsing/plugin_docs.py
, specifically theread_docstring()
method.The text was updated successfully, but these errors were encountered: