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

Panic condition documentation consistency #28384

Closed
numberten opened this issue Sep 13, 2015 · 1 comment
Closed

Panic condition documentation consistency #28384

numberten opened this issue Sep 13, 2015 · 1 comment

Comments

@numberten
Copy link

I noticed that the formatting of panic conditions in the documentation of a lot of functions seems to be inconsistent. Specifically it varies between simple warnings in the description of the function and 'Panics' subheaders with the panic condition listed below.

A good example being the difference between split_at and chunks_mut here.

I like that headers make it very explicit (visually) where the panic conditions in a function call are, but they can also lead to confusion since the same header used multiple times on a given page makes any links to them (via url#Header) direct to the topmost 'Panic' header.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Sep 30, 2015
@steveklabnik
Copy link
Member

In general, they should all be with the header, yes. At this point, since we're still doing a lot of work on the std docs, I'm doing this as I go, rather than trying to do a whole audit of every function. So I've submitted a PR for split_at, and if you can enumerate any other places, I'm happy to knock them out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants