[issue23778] Add a visual distinction to multiline versionchanged blocks
New submission from Demian Brecht: This came up during #2211, where a multiline versionchanged entry was suggested. Currently, there is no visual distinction between any but the first line of the description and the rest of the body of the docs. The attached patch adds a consistent level of indentation (30px) to all but the first child. This change makes it much more obvious where the versionchanged block ends and the rest of the docs continue. -- assignee: docs@python components: Documentation files: versionchanged_indent.patch keywords: patch messages: 239261 nosy: demian.brecht, docs@python priority: normal severity: normal stage: patch review status: open title: Add a visual distinction to multiline versionchanged blocks type: enhancement versions: Python 3.5 Added file: http://bugs.python.org/file38689/versionchanged_indent.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23778 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue23778] Add a visual distinction to multiline versionchanged blocks
R. David Murray added the comment: Heh, you clearly know more about docutils/css than I do. I don't think we want multiple blank delimited paragraphs under a versionchanged directive, though, from a style point of view. A compact unordered list would be best. -- nosy: +georg.brandl, r.david.murray ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23778 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue23778] Add a visual distinction to multiline versionchanged blocks
Demian Brecht added the comment: Sounds good to me. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23778 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue23778] Add a visual distinction to multiline versionchanged blocks
Demian Brecht added the comment: I noted in #2211 that nested lists are supported by Sphinx, so that solves that specific issue. Perhaps it /may/ still be useful to have this though in order to support multiple paragraphs for more detailed change descriptions when needed? That said, I'm not sure that's something that's necessarily even wanted as such messages are intended to be terse. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23778 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue23778] Add a visual distinction to multiline versionchanged blocks
R. David Murray added the comment: Yes, exactly, they are supposed to be terse. So I think we should reject this. -- resolution: - rejected stage: patch review - resolved status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue23778 ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
