Skip to content

Commit 1dd477b

Browse files
alyssaisnotgull
authored andcommitted
Fix rustdoc warnings for static executors
For example: warning: unresolved link to `tick` --> src/static_executors.rs:306:47 | 306 | /// to consistently drive the executor with [`tick`] or [`run`] will cause the all spawned | ^^^^ no item named `tick` in scope | = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
1 parent 054c9d1 commit 1dd477b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/static_executors.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,9 @@ impl LocalExecutor<'static> {
118118
/// A static executor may require signficantly less overhead in both single-threaded and mulitthreaded use cases.
119119
///
120120
/// As this type does not implement `Drop`, losing the handle to the executor or failing
121-
/// to consistently drive the executor with [`tick`] or [`run`] will cause the all spawned
122-
/// tasks to permanently leak. Any tasks at the time will not be cancelled.
121+
/// to consistently drive the executor with [`StaticExecutor::tick`] or
122+
/// [`StaticExecutor::run`] will cause the all spawned tasks to permanently leak. Any
123+
/// tasks at the time will not be cancelled.
123124
///
124125
/// [`static`]: https://doc.rust-lang.org/std/keyword.static.html
125126
#[repr(transparent)]
@@ -303,8 +304,9 @@ impl Default for StaticExecutor {
303304
/// A static executor may require signficantly less overhead in both single-threaded and mulitthreaded use cases.
304305
///
305306
/// As this type does not implement `Drop`, losing the handle to the executor or failing
306-
/// to consistently drive the executor with [`tick`] or [`run`] will cause the all spawned
307-
/// tasks to permanently leak. Any tasks at the time will not be cancelled.
307+
/// to consistently drive the executor with [`StaticLocalExecutor::tick`] or
308+
/// [`StaticLocalExecutor::run`] will cause the all spawned tasks to permanently leak. Any
309+
/// tasks at the time will not be cancelled.
308310
///
309311
/// [`thread_local]: https://doc.rust-lang.org/std/macro.thread_local.html
310312
#[repr(transparent)]

0 commit comments

Comments
 (0)