Skip to content

Commit

Permalink
chore: Fix rustdoc lints
Browse files Browse the repository at this point in the history
  • Loading branch information
jayvdb committed Sep 8, 2024
1 parent 2987d21 commit 6fd1278
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
5 changes: 3 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#![allow(rustdoc::invalid_html_tags)]
//! # Async version of the Rust standard library
//!
//! `async-std` is a foundation of portable Rust software, a set of minimal and battle-tested
Expand Down Expand Up @@ -191,7 +192,7 @@
//! <span
//! class="module-item stab portability"
//! style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"
//! ><code>unstable</code></span>
//! > <code>unstable</code> </span>
//! are available only when the `unstable` Cargo feature is enabled:
//!
//! ```toml
Expand All @@ -204,7 +205,7 @@
//! <span
//! class="module-item stab portability"
//! style="display: inline; border-radius: 3px; padding: 2px; font-size: 80%; line-height: 1.2;"
//! ><code>attributes</code></span>
//! > <code>attributes</code> </span>
//! are available only when the `attributes` Cargo feature is enabled:
//!
//! ```toml
Expand Down
4 changes: 2 additions & 2 deletions src/sync/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@
//! at the same time: In multi-threaded scenarios, you can use two
//! kinds of primitives to deal with synchronization:
//! - [memory fences] to ensure memory accesses are made visible to
//! other CPUs in the right order.
//! other CPUs in the right order.
//! - [atomic operations] to ensure simultaneous access to the same
//! memory location doesn't lead to undefined behavior.
//! memory location doesn't lead to undefined behavior.
//!
//! [prefetching]: https://en.wikipedia.org/wiki/Cache_prefetching
//! [compiler fences]: https://doc.rust-lang.org/std/sync/atomic/fn.compiler_fence.html
Expand Down
8 changes: 3 additions & 5 deletions src/task/block_on.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ use crate::task::Builder;
/// ```no_run
/// use async_std::task;
///
/// fn main() {
/// task::block_on(async {
/// println!("Hello, world!");
/// })
/// }
/// task::block_on(async {
/// println!("Hello, world!");
/// })
/// ```
#[cfg(not(target_os = "unknown"))]
pub fn block_on<F, T>(future: F) -> T
Expand Down

0 comments on commit 6fd1278

Please sign in to comment.