Skip to content

Fix YAML syntax issues in DOCUMENTATION#402

Merged
ttuffin merged 1 commit into
ansible:mainfrom
sivel:yaml-syntax-fixes
Feb 27, 2025
Merged

Fix YAML syntax issues in DOCUMENTATION#402
ttuffin merged 1 commit into
ansible:mainfrom
sivel:yaml-syntax-fixes

Conversation

@sivel
Copy link
Copy Markdown
Member

@sivel sivel commented Feb 27, 2025

A few of the event_source plugins had invalid DOCUMENTATION due to YAML syntax errors, this PR addresses them by using folded or block scalars.

Generally, if there is a : in the string, with whitespace to the right, YAML will split it as a key/value pair. Using folded or block scalars will resolve the issue as the whole field will be treated as a string.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 27, 2025

Label error. Requires exactly 1 of: bug, enhancement, major, minor, patch, skip-changelog. Found: documentation

@ttuffin ttuffin added the documentation Improvements or additions to documentation label Feb 27, 2025
@kaiokmo kaiokmo removed the documentation Improvements or additions to documentation label Feb 27, 2025
@kaiokmo kaiokmo added the documentation Improvements or additions to documentation label Feb 27, 2025
@sivel
Copy link
Copy Markdown
Member Author

sivel commented Feb 27, 2025

fwiw, these were found using the following commands, that kind of abuse the -M argument for ansible-doc:

for F in `ls event_filter/*.py`; do ansible-doc -M event_filter -j "$(basename $F)"; done
for F in `ls event_source/*.py`; do ansible-doc -M event_source -j "$(basename $F)"; done

Since ansible-doc does not yet support directly enumerating the extensions directory, the -M flag sets an additional module directory to look in, and treats the files within as modules.

@ttuffin ttuffin merged commit 2496b1d into ansible:main Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants