add note about collection links (#63346)

This commit is contained in:
Sandra McCann 2019-10-11 09:27:26 -04:00 committed by Alicia Cozine
parent b7f12f9ff3
commit bdd0fac606

View file

@ -275,7 +275,11 @@ You can link from your module documentation to other module docs, other resource
.. note::
- To refer a collection of modules, use ``C(..)``, e.g. ``Refer to the C(win_*) modules.``
For modules in a collection, you can only use ``L()`` and ``M()`` for content within that collection. Use ``U()`` to refer to content in a different collection.
.. note::
- To refer a group of modules, use ``C(..)``, e.g. ``Refer to the C(win_*) modules.``
- Because it stands out better, using ``seealso`` is preferred for general references over the use of notes or adding links to the description.
.. _module_docs_fragments: