Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a visual distinction to multiline versionchanged blocks #67966

Closed
demianbrecht mannequin opened this issue Mar 25, 2015 · 5 comments
Closed

Add a visual distinction to multiline versionchanged blocks #67966

demianbrecht mannequin opened this issue Mar 25, 2015 · 5 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@demianbrecht
Copy link
Mannequin

demianbrecht mannequin commented Mar 25, 2015

BPO 23778
Nosy @birkenfeld, @bitdancer, @demianbrecht
Files
  • versionchanged_indent.patch
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2015-03-25.16:42:01.387>
created_at = <Date 2015-03-25.15:22:15.262>
labels = ['type-feature', 'docs']
title = 'Add a visual distinction to multiline versionchanged blocks'
updated_at = <Date 2015-03-25.16:48:06.237>
user = 'https://github.com/demianbrecht'

    bugs.python.org fields:

    activity = <Date 2015-03-25.16:48:06.237>
actor = 'demian.brecht'
assignee = 'docs@python'
closed = True
closed_date = <Date 2015-03-25.16:42:01.387>
closer = 'r.david.murray'
components = ['Documentation']
creation = <Date 2015-03-25.15:22:15.262>
creator = 'demian.brecht'
dependencies = []
files = ['38689']
hgrepos = []
issue_num = 23778
keywords = ['patch']
message_count = 5.0
messages = ['239261', '239263', '239270', '239273', '239274']
nosy_count = 4.0
nosy_names = ['georg.brandl', 'r.david.murray', 'docs@python', 'demian.brecht']
pr_nums = []
priority = 'normal'
resolution = 'rejected'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue23778'
versions = ['Python 3.5']
    @demianbrecht
    Copy link
    Mannequin Author

    demianbrecht mannequin commented Mar 25, 2015

    This came up during bpo-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.

    @demianbrecht demianbrecht mannequin assigned docspython Mar 25, 2015
    @demianbrecht demianbrecht mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Mar 25, 2015
    @bitdancer
    Copy link
    Member

    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.

    @demianbrecht
    Copy link
    Mannequin Author

    demianbrecht mannequin commented Mar 25, 2015

    I noted in bpo-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.

    @bitdancer
    Copy link
    Member

    Yes, exactly, they are supposed to be terse. So I think we should reject this.

    @demianbrecht
    Copy link
    Mannequin Author

    demianbrecht mannequin commented Mar 25, 2015

    Sounds good to me.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @bitdancer