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

Section numbers in the Library Reference have a trailing period #55621

Closed
rhettinger opened this issue Mar 6, 2011 · 5 comments
Closed

Section numbers in the Library Reference have a trailing period #55621

rhettinger opened this issue Mar 6, 2011 · 5 comments
Assignees
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@rhettinger
Copy link
Contributor

BPO 11412
Nosy @birkenfeld, @rhettinger, @terryjreedy, @merwok

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/birkenfeld'
closed_at = <Date 2011-03-19.09:50:44.288>
created_at = <Date 2011-03-06.06:47:37.647>
labels = ['type-bug', 'docs']
title = 'Section numbers in the Library Reference have a trailing period'
updated_at = <Date 2011-03-19.09:50:44.287>
user = 'https://github.com/rhettinger'

bugs.python.org fields:

activity = <Date 2011-03-19.09:50:44.287>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2011-03-19.09:50:44.288>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2011-03-06.06:47:37.647>
creator = 'rhettinger'
dependencies = []
files = []
hgrepos = []
issue_num = 11412
keywords = []
message_count = 5.0
messages = ['130147', '130155', '130199', '131387', '131403']
nosy_count = 4.0
nosy_names = ['georg.brandl', 'rhettinger', 'terry.reedy', 'eric.araujo']
pr_nums = []
priority = 'normal'
resolution = 'works for me'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue11412'
versions = []

@rhettinger
Copy link
Contributor Author

The section headings all look like this:

     4.11. Other Built-in Types
     4.11.1. Modules
         ...

http://docs.python.org/dev/library/stdtypes.html#classes-and-class-instances

It looks like there is one dot to many

@rhettinger rhettinger added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error labels Mar 6, 2011
@birkenfeld
Copy link
Member

This looks fine to me -- isn't it a mere stylistic issue?

@rhettinger
Copy link
Contributor Author

This looks fine to me -- isn't it a mere stylistic issue?

It must be. I just checked several of the books on my shelf. Most don't have the trailing period, but Knuth does. I raised the issue because I thought it was an unintended.

@terryjreedy
Copy link
Member

My haphazard sample gave 8 without, 5 with.

I suspect trailing dot is analogy with lists:

  1. something.
  2. something else.
    2.1. detail of else
    2.2. more detail

Books without generally have extra space instead of '.'.

@birkenfeld
Copy link
Member

WFM then.

@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
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

3 participants