[docs] [issue13515] Consistent documentation practices for security concerns and considerations

Antoine Pitrou report at bugs.python.org
Sat Dec 10 19:05:54 CET 2011

Antoine Pitrou <pitrou at free.fr> added the comment:

> Note sure about icon vs. text (“Warning:”) vs. colors.  I think an
> icon would be as scary as the current big color boxes.  I like Ezio’s
> change + Antoine’s indenting suggestion.

An icon will only be scary if you chopse a scary one. A "warning" icon
can simply be an exclamation mark or something (*). It would be less
prominent than a box with a red background, while still clearly
separating the warning from the rest of the text (something which a too
small indentation does not).

Icons or drawings also make text documents less austere, which is a good
thing. There are lots of free icon sets out there, so Ezio doesn't have
to train his art skills ;)

(*) to get an idea, search "exclamation mark icon" with Google Images


Python tracker <report at bugs.python.org>

More information about the docs mailing list