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

async-await keywords are not documented in the libstd docs #66909

Closed
ultrasaurus opened this issue Nov 30, 2019 · 8 comments
Closed

async-await keywords are not documented in the libstd docs #66909

ultrasaurus opened this issue Nov 30, 2019 · 8 comments
Assignees
Labels
A-async-await A-docs AsyncAwait-Triaged C-enhancement

Comments

@ultrasaurus
Copy link

@ultrasaurus ultrasaurus commented Nov 30, 2019

I have a PR for this, just opening an issue, since I might be missing other parts of it.

I couldn't find up-to-date docs on the new async / await keywords. Std library docs have blank pages:

Perhaps there are other docs somewhere, but I thought to look at the RFC. The tracking bug is closed, but the RFC is not fully implemented.

ultrasaurus added a commit to ultrasaurus/rfcs that referenced this issue Nov 30, 2019
This RFC isn't fully implemented, but tracking bug is closed. 
This PR adds a tracking bug I found for part of the RFC that is not implemented.
There may be other open tracking bugs. This PR is intended to be an improvement,
may not be a complete fix for issue:  rust-lang/rust#66909
@ehuss
Copy link
Contributor

@ehuss ehuss commented Nov 30, 2019

@jonas-schievink jonas-schievink added A-async-await C-enhancement A-docs labels Nov 30, 2019
@nikomatsakis nikomatsakis changed the title async_await RFC is not fully implemented, but tracking issue is closed async-await keywords are not documented in the libstd docs Dec 3, 2019
@nikomatsakis nikomatsakis added AsyncAwait-OnDeck AsyncAwait-Triaged labels Dec 3, 2019
@nikomatsakis
Copy link
Contributor

@nikomatsakis nikomatsakis commented Dec 3, 2019

@ultrasaurus did you say you have a PR for adding the docs? Good catch, I wasn't aware of that documentation.

I've retitled this to suggest the specific oversight, and I'm tagged as "on deck" as it seems worth fixing (and not very difficult).

@ultrasaurus
Copy link
Author

@ultrasaurus ultrasaurus commented Dec 3, 2019

@nikomatsakis I made a super simple PR to RFC repo (rust-lang/rfcs#2828) that hasn't been reviewed yet.

I'm still working my way through the docs on async / await and am not the one to judge whether the docs in nightly are ready to be merged, just flagging that async / await are now in stable ... was it an error that docs weren't merged? if intentional, then a link to nightly docs and/or RFC would be great.

@nikomatsakis
Copy link
Contributor

@nikomatsakis nikomatsakis commented Dec 7, 2019

@ultrasaurus I see. OK, I've closed that PR since that's not our usual procedure. This is a fairly minor matter from what I can tell, I thnk we mostly would want to include some text and link to the docs in the reference for more details. (I don't think the nightly docs or RFC are especially relevant to link to.) The real question is where in the source code you go to add documentation on keywords -- probably @GuillaumeGomez would be able to answer that question.

@nikomatsakis
Copy link
Contributor

@nikomatsakis nikomatsakis commented Dec 10, 2019

@rustbot assign @gilescope

@gilescope indicated a willingness to take this one. My suggestion would be to ripgrep through the source to find where e.g. the documentation for the keyword const is to be found and then add comparable documentation for async. It could either borrow some text from the existing documentation or simply provide some links to that.

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Dec 18, 2019

Sorry, didn't see the notification... If you want to add docs for keyword, you can look here: https://github.com/rust-lang/rust/blob/master/src/libstd/keyword_docs.rs

@gilescope
Copy link
Contributor

@gilescope gilescope commented Dec 24, 2019

Thanks. Will tuck into this one now I'm on holiday.

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Jan 3, 2020

I guess this issue can be closed now. Thanks for the PR @gilescope !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-async-await A-docs AsyncAwait-Triaged C-enhancement
Projects
None yet
Development

No branches or pull requests

6 participants