diff options
| author | Felix Fontein <felix@fontein.de> | 2021-02-02 18:16:03 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-02 11:16:03 -0600 |
| commit | 25962888ac04c89362325282d170ea650627bdc0 (patch) | |
| tree | 62fd3b13b4827be393cea8dd296921427abdc89e | |
| parent | a3175e9979bc1fd18419a70028f685940530d162 (diff) | |
| download | ansible-25962888ac04c89362325282d170ea650627bdc0.tar.gz | |
Mention that C(...) should be used for inline code. (#73312) (#73374)
(cherry picked from commit 76604397cb0940d27646d8764bc6d7c1c088aabd)
| -rw-r--r-- | docs/docsite/rst/dev_guide/developing_modules_documenting.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst index 6be4fcd0e7..6f2690180f 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst @@ -241,7 +241,7 @@ content in a uniform way: * ``I()`` for option names. For example: ``Required if I(state=present).`` This is italicized in the documentation. -* ``C()`` for files and option values. For example: ``If not set the environment variable C(ACME_PASSWORD) will be used.`` This displays with a mono-space font in the documentation. +* ``C()`` for files, option values, and inline code. For example: ``If not set the environment variable C(ACME_PASSWORD) will be used.`` or ``Use C(var | foo.bar.my_filter) to transform C(var) into the required format.`` This displays with a mono-space font in the documentation. * ``B()`` currently has no standardized usage. It is displayed in boldface in the documentation. * ``HORIZONTALLINE`` is used sparingly as a separator in long descriptions. It becomes a horizontal rule (the ``<hr>`` html tag) in the documentation. |