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

Documentation on website is missing section numbers #48305

Closed
ivazquez mannequin opened this issue Oct 6, 2008 · 2 comments
Closed

Documentation on website is missing section numbers #48305

ivazquez mannequin opened this issue Oct 6, 2008 · 2 comments
Assignees
Labels
docs Documentation in the Doc dir performance Performance or resource usage

Comments

@ivazquez
Copy link
Mannequin

ivazquez mannequin commented Oct 6, 2008

BPO 4055
Nosy @birkenfeld

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 2008-10-08.16:44:58.145>
created_at = <Date 2008-10-06.16:36:34.364>
labels = ['docs', 'performance']
title = 'Documentation on website is missing section numbers'
updated_at = <Date 2008-10-08.16:44:58.128>
user = 'https://bugs.python.org/ivazquez'

bugs.python.org fields:

activity = <Date 2008-10-08.16:44:58.128>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-10-08.16:44:58.145>
closer = 'georg.brandl'
components = ['Documentation']
creation = <Date 2008-10-06.16:36:34.364>
creator = 'ivazquez'
dependencies = []
files = []
hgrepos = []
issue_num = 4055
keywords = []
message_count = 2.0
messages = ['74381', '74532']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'ivazquez']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = None
status = 'closed'
superseder = None
type = 'performance'
url = 'https://bugs.python.org/issue4055'
versions = ['Python 2.6']

@ivazquez
Copy link
Mannequin Author

ivazquez mannequin commented Oct 6, 2008

The documentation on the website seems to have lost the numbers
identifying the various sections. It was useful to point a user to e.g.
§3.6.2 of the libref in order to guide them to the string interpolation
documentation. This is now no longer possible, and instead the user must
hunt around for the appropriate section. This is a severe usability hit
against the documentation.

@ivazquez ivazquez mannequin assigned birkenfeld Oct 6, 2008
@ivazquez ivazquez mannequin added docs Documentation in the Doc dir performance Performance or resource usage labels Oct 6, 2008
@birkenfeld
Copy link
Member

I disagree that missing section numbers are a severe usability hit.
Especially in the context that the new docs are constantly updated,
there's no telling when section numbers will shift, misleading those who
only navigate by section number. In contrast, a link is persistent and
usually also quicker to get to.

That said, I acknowledge the wish for section numbers, and there is an
issue entry about it in the tracker for the Sphinx project, which is
used to build the new docs, at <http://code.google.com/p/sphinx\>.

Closing this one as duplicate.

@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 performance Performance or resource usage
Projects
None yet
Development

No branches or pull requests

1 participant