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

Open
steveklabnik opened this Issue Oct 26, 2015 · 26 comments

Comments

Projects
None yet
@steveklabnik
Member

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.

@GuillaumeGomez

This comment has been minimized.

Show comment
Hide comment
@GuillaumeGomez

GuillaumeGomez Feb 22, 2016

Member

I'm going to take a look as soon as I can.

Member

GuillaumeGomez commented Feb 22, 2016

I'm going to take a look as soon as I can.

@GuillaumeGomez

This comment has been minimized.

Show comment
Hide comment
@GuillaumeGomez

GuillaumeGomez Apr 6, 2016

Member

I toggled the added docs. All up to date now.

Member

GuillaumeGomez commented Apr 6, 2016

I toggled the added docs. All up to date now.

@critiqjo

This comment has been minimized.

Show comment
Hide comment
@critiqjo

critiqjo Apr 11, 2016

Has anyone started working on replacing [hoedown] with pulldown-cmark?

This is almost done now, except for rendering of books. Once the buildsystem is moved to Cargo-based, I think we should also think about supporting custom links.

Has anyone started working on replacing [hoedown] with pulldown-cmark?

This is almost done now, except for rendering of books. Once the buildsystem is moved to Cargo-based, I think we should also think about supporting custom links.

@steveklabnik

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Apr 11, 2016

Member

@critiqjo oh wow! That's awesome

Member

steveklabnik commented Apr 11, 2016

@critiqjo oh wow! That's awesome

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

This comment has been minimized.

Show comment
Hide comment
@matthew-piziak

matthew-piziak Aug 15, 2016

Contributor

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

Contributor

matthew-piziak commented Aug 15, 2016

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

@critiqjo

This comment has been minimized.

Show comment
Hide comment
@critiqjo

critiqjo Dec 11, 2016

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

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

This comment has been minimized.

Show comment
Hide comment
@matthew-piziak

matthew-piziak Dec 11, 2016

Contributor

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

Contributor

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

This comment has been minimized.

Show comment
Hide comment
@GuillaumeGomez

GuillaumeGomez Dec 11, 2016

Member

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

Member

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

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Dec 11, 2016

Member

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.

Member

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

This comment has been minimized.

Show comment
Hide comment
@frewsxcv

frewsxcv Dec 15, 2016

Member

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

Member

frewsxcv commented Dec 15, 2016

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

@steveklabnik

This comment has been minimized.

Show comment
Hide comment
@steveklabnik

steveklabnik Mar 24, 2017

Member

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.

Member

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

SamWhited added a commit to SamWhited/rust that referenced this issue Mar 30, 2017

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.

Updates #29329, #29381

SamWhited added a commit to SamWhited/rust that referenced this issue Mar 30, 2017

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.

Updates #29329, #29381

SamWhited added a commit to SamWhited/rust that referenced this issue Mar 30, 2017

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.

Updates #29329, #29381

Remove extra macro ! in docs

SamWhited added a commit to SamWhited/rust that referenced this issue Mar 30, 2017

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.

Updates #29329, #29381

frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 31, 2017

Rollup merge of #40934 - SamWhited:improve_write_writeln_docs, r=stev…
…eklabnik

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 #29329, #29381

frewsxcv added a commit to frewsxcv/rust that referenced this issue Mar 31, 2017

Rollup merge of #40934 - SamWhited:improve_write_writeln_docs, r=stev…
…eklabnik

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 #29329, #29381

michaelwoerister added a commit to michaelwoerister/rust that referenced this issue Apr 7, 2017

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.

Updates #29329, #29381
@lukaramu

This comment has been minimized.

Show comment
Hide comment
@lukaramu

lukaramu Apr 15, 2017

Contributor

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
Contributor

lukaramu 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

This comment has been minimized.

Show comment
Hide comment
@Mark-Simulacrum

Mark-Simulacrum Apr 15, 2017

Member

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

path and ascii still need to be added.

Member

Mark-Simulacrum commented Apr 15, 2017

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

path and ascii still need to be added.

@marioidival

This comment has been minimized.

Show comment
Hide comment
@marioidival

marioidival Aug 2, 2017

Contributor

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

Contributor

marioidival commented Aug 2, 2017

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

@GuillaumeGomez

This comment has been minimized.

Show comment
Hide comment
@GuillaumeGomez

GuillaumeGomez Aug 2, 2017

Member

Updated.

Member

GuillaumeGomez commented Aug 2, 2017

Updated.

AndyGauge added a commit to AndyGauge/rust that referenced this issue Aug 29, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment