Skip to content

Commit

Permalink
Rollup merge of #79611 - poliorcetics:use-std-in-docs, r=jyn514
Browse files Browse the repository at this point in the history
Use more std:: instead of core:: in docs for consistency

``@rustbot`` label T-doc

Some cleanup work to use `std::` instead of `core::` in docs as much as possible. This helps with terminology and consistency, especially for newcomers from other languages that have often heard of `std` to describe the standard library but not of `core`.

Edit: I also added more intra doc links when I saw the opportunity.
  • Loading branch information
Dylan-DPC authored Dec 4, 2020
2 parents 6b42900 + 4eb76fc commit 88f0c72
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 17 deletions.
2 changes: 1 addition & 1 deletion library/core/src/fmt/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ impl<'a> Arguments<'a> {
/// ```rust
/// #![feature(fmt_as_str)]
///
/// use core::fmt::Arguments;
/// use std::fmt::Arguments;
///
/// fn write_str(_: &str) { /* ... */ }
///
Expand Down
2 changes: 1 addition & 1 deletion library/core/src/future/pending.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub struct Pending<T> {
/// # Examples
///
/// ```no_run
/// use core::future;
/// use std::future;
///
/// # async fn run() {
/// let future = future::pending();
Expand Down
6 changes: 3 additions & 3 deletions library/core/src/future/poll_fn.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use crate::future::Future;
use crate::pin::Pin;
use crate::task::{Context, Poll};

/// Creates a future that wraps a function returning `Poll`.
/// Creates a future that wraps a function returning [`Poll`].
///
/// Polling the future delegates to the wrapped function.
///
Expand All @@ -13,7 +13,7 @@ use crate::task::{Context, Poll};
/// #![feature(future_poll_fn)]
/// # async fn run() {
/// use core::future::poll_fn;
/// use core::task::{Context, Poll};
/// use std::task::{Context, Poll};
///
/// fn read_line(_cx: &mut Context<'_>) -> Poll<String> {
/// Poll::Ready("Hello, World!".into())
Expand All @@ -31,7 +31,7 @@ where
PollFn { f }
}

/// A Future that wraps a function returning `Poll`.
/// A Future that wraps a function returning [`Poll`].
///
/// This `struct` is created by [`poll_fn()`]. See its
/// documentation for more.
Expand Down
2 changes: 1 addition & 1 deletion library/core/src/future/ready.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ impl<T> Future for Ready<T> {
/// # Examples
///
/// ```
/// use core::future;
/// use std::future;
///
/// # async fn run() {
/// let a = future::ready(1);
Expand Down
2 changes: 1 addition & 1 deletion library/core/src/panic.rs
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ impl<'a> Location<'a> {
/// # Examples
///
/// ```
/// use core::panic::Location;
/// use std::panic::Location;
///
/// /// Returns the [`Location`] at which it is called.
/// #[track_caller]
Expand Down
19 changes: 11 additions & 8 deletions library/core/src/task/ready.rs
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
/// Extracts the successful type of a `Poll<T>`.
/// Extracts the successful type of a [`Poll<T>`].
///
/// This macro bakes in propagation of `Pending` signals by returning early.
/// This macro bakes in propagation of [`Pending`] signals by returning early.
///
/// [`Poll<T>`]: crate::task::Poll
/// [`Pending`]: crate::task::Poll::Pending
///
/// # Examples
///
/// ```
/// #![feature(ready_macro)]
///
/// use core::task::{ready, Context, Poll};
/// use core::future::{self, Future};
/// use core::pin::Pin;
/// use std::task::{ready, Context, Poll};
/// use std::future::{self, Future};
/// use std::pin::Pin;
///
/// pub fn do_poll(cx: &mut Context<'_>) -> Poll<()> {
/// let mut fut = future::ready(42);
Expand All @@ -28,9 +31,9 @@
/// ```
/// # #![feature(ready_macro)]
/// #
/// # use core::task::{Context, Poll};
/// # use core::future::{self, Future};
/// # use core::pin::Pin;
/// # use std::task::{Context, Poll};
/// # use std::future::{self, Future};
/// # use std::pin::Pin;
/// #
/// # pub fn do_poll(cx: &mut Context<'_>) -> Poll<()> {
/// # let mut fut = future::ready(42);
Expand Down
4 changes: 2 additions & 2 deletions library/std/src/primitive_docs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ mod prim_bool {}
/// words, they can't return `!` from every code path. As an example, this code doesn't compile:
///
/// ```compile_fail
/// use core::ops::Add;
/// use std::ops::Add;
///
/// fn foo() -> impl Add<u32> {
/// unimplemented!()
Expand All @@ -208,7 +208,7 @@ mod prim_bool {}
/// But this code does:
///
/// ```
/// use core::ops::Add;
/// use std::ops::Add;
///
/// fn foo() -> impl Add<u32> {
/// if true {
Expand Down

0 comments on commit 88f0c72

Please sign in to comment.