Skip to content

Commit 439cda8

Browse files
Apply suggestions from code review
Co-authored-by: Felix Fontein <[email protected]>
1 parent 8af81fe commit 439cda8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/docsite/rst/plugins/cache.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The default cache plugin is the :ref:`memory <memory_cache>` plugin, which only
1313

1414
You can use different cache plugins for inventory and facts. If you enable inventory caching without setting an inventory-specific cache plugin, Ansible uses the fact cache plugin for both facts and inventory. If necessary, you can :ref:`create custom cache plugins <developing_cache_plugins>`.
1515

16-
A cache plugin implementation is an internal implementation detail, and should not be relied upon by external uses. The format of the data or how it is stored is a concern for the plugin, and this data may change or even be absent. As such, the cache of jsonfile, redis, or any other cache plugin should not be interrogated external to the cache plugin itself.
16+
A cache plugin implementation is an internal implementation detail, and should not be relied upon by external uses. The format of the data or how it is stored is a concern for the plugin, and this data may change or even be absent. As such, the cache of :ansplugin:`ansible.builtin.jsonfile#cache`, :ansplugin:`community.general.redis#cache`, or any other cache plugin should not be interrogated external to the cache plugin itself.
1717

1818
The cache maintained by a cache plugin is only to be used indirectly within a playbook, without any concept that the data even came from a cache.
1919

@@ -46,7 +46,7 @@ To enable a custom cache plugin, save it in one of the directory sources configu
4646

4747
You also need to configure other settings specific to each plugin. Consult the individual plugin documentation or the Ansible :ref:`configuration <ansible_configuration_settings>` for more details.
4848

49-
.. Note:
49+
.. note::
5050

5151
The existence of the cache, or an individual item in the cache should not be a hard requirement. Playbooks should not be written in a way as to potentially failing if the cache or a specific value is missing.
5252
A cache hit or miss should not affect a playbook operation.

0 commit comments

Comments
 (0)