Skip to content

Commit

Permalink
docs: Clarify release descriptions *must not* contain embedded URL
Browse files Browse the repository at this point in the history
Resolves: #578
  • Loading branch information
ximion committed Feb 19, 2024
1 parent 4537dce commit fc58bf2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/xml/releases-data.xml
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
The <literal>description</literal> tag supports child tags as described in <xref linkend="tag-description"/>.
</para>
<para>
It is recommended to not link to issue trackers or bug reports, as these typically make no sense to users.
Descriptions must not contain embedded web links to issue trackers or bug reports, as these typically make no sense to users.
If particular issues need to be highlighted (for example, CVEs fixed in this release), they should be listed in the <literal>issues</literal> tag.
</para>
</listitem>
Expand Down

0 comments on commit fc58bf2

Please sign in to comment.