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

Change "Contents" to "Table of Contents" ? (Or delete it?) #2540

Closed
gvanrossum opened this issue Apr 19, 2022 · 3 comments · Fixed by #2541
Closed

Change "Contents" to "Table of Contents" ? (Or delete it?) #2540

gvanrossum opened this issue Apr 19, 2022 · 3 comments · Fixed by #2541
Assignees
Labels
infra Core infrastructure for building and rendering PEPs

Comments

@gvanrossum
Copy link
Member

Currently PEPs have a "mysterious" triangle pointing to the word "Contents". I don't know why, but somehow every time I see this I do a double take before I realize "oh, that's the ToC". Maybe spell "Table of Contents" in full? There should be plenty of horizontal space for that. (Not in the side bar though -- there mightn't be room for it, and there it's always expanded which provides enough context for the single word to be understood.)

Alternatively, why have this in the main body of the PEP at all when it's already in the sidebar?

(If there was a "nit" label I'd check it. :-)

@CAM-Gerlach CAM-Gerlach added the infra Core infrastructure for building and rendering PEPs label Apr 19, 2022
@CAM-Gerlach CAM-Gerlach self-assigned this Apr 19, 2022
@CAM-Gerlach
Copy link
Member

Currently PEPs have a "mysterious" triangle pointing to the word "Contents". I don't know why, but somehow every time I see this I do a double take before I realize "oh, that's the ToC". Maybe spell "Table of Contents" in full?

Seems reasonable, especially given it is currently causing confusion. It appears to be used a handful of different places in the code, so not as a trivial as it should be, but not hard either.

Alternatively, why have this in the main body of the PEP at all when it's already in the sidebar?

As discussed in #2364 that implemented the collapsed ToC, this was based on the consensus of the PEP 676 discussion on Discourse on that topic; I'd suggested removing it as it didn't seem to serve a clear purpose, but some people said they liked having it inline and making it a collapsible section seemed a decent compromise, as it didn't take up hardly any space. Also, we do need it on narrow widths/mobile, where the sidebar isn't shown (since we don't currently have a "hamburger menu" for navigation) so if we did elide it, what we would do is just hide it above the breakpoint where we show the sidebar.

@gvanrossum
Copy link
Member Author

Okay, collapsed ToC with heading "Table of Contents" seems reasonable enough.

@CAM-Gerlach
Copy link
Member

Sure, done in #2541 . I just changed it in the HTML translator which didn't affect the RST doctree, so it actually did end up being pretty trivial after all.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Core infrastructure for building and rendering PEPs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants