starlingx/docs
Code Issues Proposed changes

Update comments

Browse Source 
Update include comment markers to wrap note only

Change-Id: I8883471b68cc93e0b4f50092b2e541e15d46bc48
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2024-11-22 15:03:44 +00:00
parent cee84df628
commit bbe734b194
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/contributor/doc_contribute_guide.rst
View File

@ -1486,8 +1486,6 @@ Use the :command:`system help` command for the full list of options.
Cross-references
****************
.. begin-xrefs
Cross-reference to arbitrary locations in a document using the ``ref`` role and
a named target. Named targets must precede a section heading. For more
information on references, see `Internal Hyperlink Targets
@ -1501,6 +1499,8 @@ When using external references, be sure to prefix the URL with either
`Internal Hyperlink Targets
<http://docutils.sourceforge.net/docs/user/rst/quickref.html#internal-hyperlink-targets>`_.
.. begin-xrefs-sample-note
.. note::
When providing an example of a URL format, treat the example as code by
@ -1511,7 +1511,7 @@ When using external references, be sure to prefix the URL with either
``https://<fqdn>/<path>``
.. end-xrefs
.. end-xrefs-sample-note
**Input:**