API Docs: ascii #29341

Activity

1. steveklabnik

   added

   A-docs

   on Oct 26, 2015
2. steveklabnik commented on Mar 8, 2017

   

   steveklabnik

   on Mar 8, 2017

   ContributorAuthor

   More actions

   I am happy to mentor anyone who wants to tackle this issue.
3. steveklabnik

   added

   E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

   A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and tools

   on Mar 8, 2017
4. eugene-bulkin commented on Mar 20, 2017

   

   eugene-bulkin

   on Mar 20, 2017

   More actions

   What exactly still needs to be documented for this module? Doesn't look like a whole lot is in there.
5. steveklabnik commented on Mar 20, 2017

   

   steveklabnik

   on Mar 20, 2017

   ContributorAuthor

   More actions

   Hey @eugene-bulkin ! Some of these issues were opened as just a "make sure we check these docs at least once.", so in some sense, you've already helped!

   Things I'd note:

   • The module-level docs are extremely short. There's not a lot to this module, but adding some extra context, for example, that most stuff in rust is utf-8, and a short summary of the two things in it would be good.
   • https://doc.rust-lang.org/std/ascii/struct.EscapeDefault.html should look more like https://doc.rust-lang.org/stable/std/iter/struct.Chain.html, that is, it doesn't follow our standard "this is an iterator method" boilerplate, complete with linking up the function that makes it
   • https://doc.rust-lang.org/std/ascii/fn.escape_default.html is pretty decent, but an example for each of those rules would be awesome.
   • https://doc.rust-lang.org/std/ascii/trait.AsciiExt.html looks pretty good. Using 'utf8' as variable names isn't great here though, as ASCII and UTF-8 are compatible, that is, all valid ASCII is also valid UTF-8, so maybe making sure to re-word this as "ascii and non-ascii" rather than "ascii and utf-8" would be better.

   That's about it I think! I'd love a PR for any part of this, or all of it if you have the time.
6. eugene-bulkin commented on Mar 20, 2017

   

   eugene-bulkin

   on Mar 20, 2017

   More actions

   I'm currently out of town so I won't be able to do anything for a week but if no one has claimed this by the time I get back I'll gladly take it on!
7. steveklabnik

   added

   E-help-wantedCall for participation: Help is requested to fix this issue.Call for participation: Help is requested to fix this issue.

   E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.Call for participation: Medium difficulty. Experience needed to fix: Intermediate.

   P-mediumMedium priorityMedium priority

   and removed

   A-docs

   on Mar 24, 2017
8. eugene-bulkin commented on Apr 1, 2017

   

   eugene-bulkin

   on Apr 1, 2017

   More actions

   Hey, I'm back from vacation and it looks like no one's claimed it, so I'll take it on!
9. frewsxcv

   added 12 commits that reference this issue on Apr 2, 2017

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   3d62722

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   2099263

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   a81aaf4

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   139e346

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   b29de46

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   b491a4d

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   2dbc1c8

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   ff1467a

   Rollup merge of rust-lang#40988 - eugene-bulkin:ascii-docs, r=frewsxcv

   ...

   469fe7a
10. chordowl commented on Apr 15, 2017

    

    chordowl

    on Apr 15, 2017

    Contributor

    More actions

    I think this issue can be closed (as of #40988); the docs look pretty good now, as everything @steveklabnik noted above seems to be addressed! 🎉

    🎉React with 🎉1Reacted by Eugene Bulkin
11. steveklabnik commented on Apr 16, 2017

    

    steveklabnik

    on Apr 16, 2017

    ContributorAuthor

    More actions

    woo!
12. steveklabnik

    closed this as completedon Apr 16, 2017