diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2021-11-02 19:31:15 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-11-02 19:31:15 +0000 |
| commit | 569ecd699d1d7f346359b482ad7435fb44ff388b (patch) | |
| tree | 4934dc5bf4898d1a136862e92d7296c98c9df9bf /examples/std/src | |
| parent | 11b0a89b6a46a0d50a8b16d0607a672f9399e01a (diff) | |
| parent | 3dd39e3d46eae91ccc0773f1ac5d31b6469c16e7 (diff) | |
Merge #467
467: docs: fix some `cargo doc` warnings r=lulf a=numero-744
There are still 3 warnings (below)
```
Documenting embassy v0.1.0 (embassy)
warning: unresolved link to `channel`
--> src/channel/mpsc.rs:241:22
|
241 | /// [`channel`]: channel
| ^^^^^^^ no item named `channel` in scope
|
= note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `Task::spawn`
--> src/executor/raw/mod.rs:105:12
|
105 | /// with [`Task::spawn()`], which will fail if it is already spawned.
| ^^^^^^^^^^^^^ no item named `Task` in scope
warning: public documentation for `spawn` links to private item `Executor::spawn`
--> src/executor/raw/mod.rs:156:17
|
156 | /// cause [`Executor::spawn()`] to return the error.
| ^^^^^^^^^^^^^^^^^ this item is private
|
= note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
= note: this link will resolve properly if you pass `--document-private-items`
warning: `embassy` (lib doc) generated 3 warnings
```
Co-authored-by: Côme ALLART <[email protected]>
Diffstat (limited to 'examples/std/src')
0 files changed, 0 insertions, 0 deletions
