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

The Standard Library Documentation Checklist #29329

Closed
steveklabnik opened this issue Oct 26, 2015 · 27 comments
Closed

The Standard Library Documentation Checklist #29329

steveklabnik opened this issue Oct 26, 2015 · 27 comments

Comments

@steveklabnik
Copy link
Member

@steveklabnik steveklabnik commented Oct 26, 2015

I've been doing work on random parts of the standard library, but it's time to get systematic.

Here's a list of all of the top-level modules in std, with separate tracking issues for each part. Documentation is never done, but I'd at least like to ensure that every module is seen at least once.

PRs will be sent for consistency, more examples, better explanations, all the usual stuff. But here's how we can track progress.

One specific area where we can do much better is linking of types to their docs in text explanations.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Jul 25, 2016
bors added a commit that referenced this issue Jul 26, 2016
steveklabnik added a commit to steveklabnik/rust that referenced this issue Jul 26, 2016
@matthew-piziak
Copy link
Contributor

@matthew-piziak matthew-piziak commented Aug 15, 2016

@steveklabnik Looks like io, num, std::slice, and vec are closed and can be checked off.

@critiqjo
Copy link

@critiqjo critiqjo commented Dec 11, 2016

Suggestion: Turn this into a Project? (Might help in gaining visibility, or just to test if the workflow helps?)

@matthew-piziak
Copy link
Contributor

@matthew-piziak matthew-piziak commented Dec 11, 2016

@critiqjo I like that idea! Is anybody against it? I would put one up but it seems that project creation is restricted.

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Dec 11, 2016

I think I went over every items. Once I have time, I'll try to check if I missed any.

@steveklabnik
Copy link
Member Author

@steveklabnik steveklabnik commented Dec 11, 2016

We haven't, as a matter of project policy, decided if we're using projects, and for what.

We should talk about it at the next docs meeting.

@frewsxcv
Copy link
Member

@frewsxcv frewsxcv commented Dec 15, 2016

Opened an issue for moving to pulldown-cmark: #38400

@steveklabnik
Copy link
Member Author

@steveklabnik steveklabnik commented Mar 24, 2017

Update: I'm going to go through all of the ones that are still open today and elaborate on exactly what they need to have done to be considered closed.

@steveklabnik steveklabnik added P-medium and removed A-docs labels Mar 24, 2017
frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 31, 2017
…s, r=steveklabnik

Improve the docs for the write and writeln macros

This change reduces duplication by linking the documentation for
`writeln!` to `write!`. It also restructures the `write!` documentation
to read in a more logical manner (I hope; feedback would be welcome).

Updates rust-lang#29329, rust-lang#29381
frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 31, 2017
…s, r=steveklabnik

Improve the docs for the write and writeln macros

This change reduces duplication by linking the documentation for
`writeln!` to `write!`. It also restructures the `write!` documentation
to read in a more logical manner (I hope; feedback would be welcome).

Updates rust-lang#29329, rust-lang#29381
michaelwoerister added a commit to michaelwoerister/rust that referenced this issue Apr 7, 2017
This change reduces duplication by linking the documentation for
`writeln!` to `write!`. It also restructures the `write!` documentation
to read in a more logical manner.

Updates rust-lang#29329, rust-lang#29381
@chordowl
Copy link
Contributor

@chordowl chordowl commented Apr 15, 2017

Update:

  • env is checked off, but probably shouldn't be, as #29351 is open
  • the issues for hash, net, and std::str have been closed, so these can be checked off
  • path isn't listed currently (#29368)
  • ascii isn't listed currently either; #29341 is still open, but can be closed, so this should probably be checked off as well
  • option was already checked off somehow, but the issue is still open; as for ascii though, it has been addressed and can be closed as far as I can tell
@Mark-Simulacrum
Copy link
Member

@Mark-Simulacrum Mark-Simulacrum commented Apr 15, 2017

Unchecked env.
Checked hash, net, and std::str.

path and ascii still need to be added.

@marioidival
Copy link
Member

@marioidival marioidival commented Aug 2, 2017

@steveklabnik update checklist please:
convert, done
env, done

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Aug 2, 2017

Updated.

AndyGauge added a commit to AndyGauge/rust that referenced this issue Aug 29, 2017
@steveklabnik
Copy link
Member Author

@steveklabnik steveklabnik commented Jan 8, 2019

I think this issue has served its use. There's only a few things left, and we can track them in their own issues.

Thank you to everyone who pitched in and made the standard library docs better over the last three years! ❤️

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

Successfully merging a pull request may close this issue.

None yet