Skip to content

[PR #2867/0514c9d8 backport][stable-2.19] Fixed minor grammatical errors #2875

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

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docsite/rst/dev_guide/sidecar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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::

Expand Down