Skip to content

Argument Clinic HOWTO listed multiple times in HOWTO index #64547

Closed
Closed
Argument Clinic HOWTO listed multiple times in HOWTO index#64547
Assignees
ezio-melotti
Labels
docsDocumentation in the Doc dirtype-featureA feature request or enhancement

Description

@brettcannon
brettcannon
opened on Jan 22, 2014
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']

    Activity

    1. brettcannon commented on Jan 22, 2014

      @brettcannon
      brettcannon
      on Jan 22, 2014
      MemberAuthor

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

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

    2. brettcannon
      assigned
      larryhastings
      on Jan 22, 2014
    3. brettcannon
      added
      docsDocumentation in the Doc dir
      on Jan 22, 2014

    4. zormit commented on Jan 22, 2014

      @zormit
      zormitmannequin
      on Jan 22, 2014
      Mannequin

      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

    5. larryhastings commented on Jan 25, 2014

      @larryhastings
      larryhastings
      on Jan 25, 2014
      Contributor

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

    6. python-dev commented on Jan 25, 2014

      @python-dev
      python-devmannequin
      on Jan 25, 2014
      Mannequin

      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

    7. ezio-melotti commented on Jan 25, 2014

      @ezio-melotti
      ezio-melotti
      on Jan 25, 2014
      Member

      Fixed, thanks for the patch!

    8. ezio-melotti
      closed this as completedon Jan 25, 2014
    9. ezio-melotti
      assigned
      ezio-melotti
      and unassigned
      larryhastings
      on Jan 25, 2014
    10. ezio-melotti
      added
      type-featureA feature request or enhancement
      on Jan 25, 2014

    11. brettcannon commented on Jan 27, 2014

      @brettcannon
      brettcannon
      on Jan 27, 2014
      MemberAuthor

      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.

    12. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    13. AA-Turner
      added a commit that references this issue on Sep 13, 2023

      GitHub-Issue-Link: python/cpython#64547

      4259315
    14. erlend-aasland
      added a commit that references this issue on Sep 26, 2023

      GitHub-Issue-Link: python/cpython#64547

      adecaef
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    Labels

    docsDocumentation in the Doc dirtype-featureA feature request or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions