centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-27 13:28:51 +07:00
Code Issues Packages Projects Releases Wiki Activity

Fixed minor grammatical errors (#2867)

Browse Source
This commit is contained in:
Sayanta Banerjee
2025-07-22 21:12:16 +05:30
committed by GitHub
parent 4f1bbe8b91
commit 0514c9d8f8
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/docsite/rst/dev_guide/sidecar.rst
View File

@@ -20,7 +20,7 @@ The format of a YAML documentation file is nearly identical to its Python equiva
YAML format
-----------
In Python each section is a variable ``DOCUMENTATION = r""" ... """`` while in YAML it is a mapping key ``DOCUMENTATION: ...``.
In Python, each section is a variable ``DOCUMENTATION = r""" ... """`` while in YAML, it is a mapping key ``DOCUMENTATION: ...``.
Here is a longer example that shows documentation as embedded in a Python file:
@@ -82,7 +82,7 @@ Any adjacent YAML documentation files must be in the same directory as the plugi
Supported plugin types
----------------------
YAML documentation is mainly intended for filters, tests and modules. While it is possible to use with other plugin types, Ansible always recommends having documentation in the same file as the code for most cases.
YAML documentation is mainly intended for filters, tests, and modules. While it is possible to use it with other plugin types, Ansible always recommends having documentation in the same file as the code for most cases.
.. seealso::