Argument Clinic HOWTO listed multiple times in HOWTO index

[brettcannon]

BPO	20348
Nosy	@brettcannon, @larryhastings, @ezio-melotti
Files	Doc-clinic.rst.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 = 'https://github.com/ezio-melotti'
closed_at = <Date 2014-01-25.15:29:04.102>
created_at = <Date 2014-01-22.16:39:07.899>
labels = ['type-feature', 'docs']
title = 'Argument Clinic HOWTO listed multiple times in HOWTO index'
updated_at = <Date 2014-01-27.13:37:25.971>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2014-01-27.13:37:25.971>
actor = 'brett.cannon'
assignee = 'ezio.melotti'
closed = True
closed_date = <Date 2014-01-25.15:29:04.102>
closer = 'ezio.melotti'
components = ['Documentation']
creation = <Date 2014-01-22.16:39:07.899>
creator = 'brett.cannon'
dependencies = []
files = ['33630']
hgrepos = []
issue_num = 20348
keywords = ['patch']
message_count = 6.0
messages = ['208824', '208836', '209186', '209204', '209206', '209441']
nosy_count = 5.0
nosy_names = ['brett.cannon', 'larry', 'ezio.melotti', 'python-dev', 'zormit']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue20348'
versions = ['Python 3.4']

[brettcannon]

http://docs.python.org/3.4/howto/

Seems several sections are listed on their own in the index.

[zormit]

Here's a patch that changes the headings in clinic.rst, such that only the first appears in the HOWTO listing. I also adapted the first according to the convention in http://docs.python.org/devguide/documenting.html#sections

[larryhastings]

You should only put one line of equals signs? I'll try to remember that in the future. LGTM. Shall I commit it?

[python-dev]

New changeset 1eec62cf3675 by Ezio Melotti in branch 'default':
bpo-20348: fix headers markup in Argument Clinic howto. Patch by Moritz Neeb.
http://hg.python.org/cpython/rev/1eec62cf3675

[ezio-melotti]

Fixed, thanks for the patch!

[brettcannon]

Technically you should only have one title at the very top of the heading hierarchy. That's why the patch changed the title to use top+bottom asterisks. You could have just as easily used equal signs as reST doesn't care, just that you are consistent.