about summary refs log tree commit diff
path: root/compiler/rustc_codegen_llvm/src
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2021-07-04 20:00:57 +0000
committerbors <bors@rust-lang.org>2021-07-04 20:00:57 +0000
commitb3d11f95cc5dd687fdd185ce91e02ebe40e6f46b (patch)
treec51c621edcb81bc07d8ac0b8c87275145aa55aa9 /compiler/rustc_codegen_llvm/src
parent23c652dfe3043369e6f23a79f8efb77f391c0e64 (diff)
parenta06ee821b7fd181ceaa9641e481e78f3189f434b (diff)
downloadrust-b3d11f95cc5dd687fdd185ce91e02ebe40e6f46b.tar.gz
rust-b3d11f95cc5dd687fdd185ce91e02ebe40e6f46b.zip
Auto merge of #86598 - yoshuawuyts:poll-method-docs, r=JohnTitor
Add examples to the various methods of `core::task::Poll`

This improves the documentation of the various methods of [`core::task::Poll`](https://doc.rust-lang.org/std/task/enum.Poll.html). These currently have fairly simple docs with no examples. This PR changes these methods to be closer to `core::option::Option` and adds usage examples (and importantly: tests!) to `Poll`'s methods.

cc/ `@rust-lang/wg-async-foundations`

## Screenshots

<details>
<summary>View generated rustdoc page</summary>
<image src="https://user-images.githubusercontent.com/2467194/123286616-59ee9b00-d50e-11eb-9e02-40269070f904.png" alt="Poll in core::task"></details>
Diffstat (limited to 'compiler/rustc_codegen_llvm/src')
0 files changed, 0 insertions, 0 deletions