mathieu/granite-rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Rollup merge of #76876 - denisvasilik:intra-doc-links-alloc, r=jyn514

Browse source 
Move to intra-doc links in collections/btree/map.rs and collections/linked_list.rs

Helps with #75080.

@rustbot modify labels: T-doc, A-intra-doc-links
This commit is contained in:
Ralf Jung 2020-09-20 15:51:53 +02:00 • committed by GitHub
commit 39412011a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
library/alloc/src/collections/btree/map.rs
View file

@ -47,7 +47,6 @@ use UnderflowResult::*;
/// any other key, as determined by the [`Ord`] trait, changes while it is in the map. This is /// any other key, as determined by the [`Ord`] trait, changes while it is in the map. This is
/// normally only possible through [`Cell`], [`RefCell`], global state, I/O, or unsafe code. /// normally only possible through [`Cell`], [`RefCell`], global state, I/O, or unsafe code.
/// ///
/// [`Ord`]: core::cmp::Ord
/// [`Cell`]: core::cell::Cell /// [`Cell`]: core::cell::Cell
/// [`RefCell`]: core::cell::RefCell /// [`RefCell`]: core::cell::RefCell
/// ///
@ -93,9 +92,10 @@ use UnderflowResult::*;
/// } /// }
/// ``` /// ```
/// ///
/// `BTreeMap` also implements an [`Entry API`](#method.entry), which allows /// `BTreeMap` also implements an [`Entry API`], which allows for more complex
/// for more complex methods of getting, setting, updating and removing keys and /// methods of getting, setting, updating and removing keys and their values:
/// their values: ///
/// [`Entry API`]: BTreeMap::entry
/// ///
/// ``` /// ```
/// use std::collections::BTreeMap; /// use std::collections::BTreeMap;
@ -453,8 +453,6 @@ impl<K: Debug + Ord, V: Debug> Debug for Entry<'_, K, V> {
/// A view into a vacant entry in a `BTreeMap`. /// A view into a vacant entry in a `BTreeMap`.
/// It is part of the [`Entry`] enum. /// It is part of the [`Entry`] enum.
///
/// [`Entry`]: enum.Entry.html
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub struct VacantEntry<'a, K: 'a, V: 'a> { pub struct VacantEntry<'a, K: 'a, V: 'a> {
key: K, key: K,
@ -474,8 +472,6 @@ impl<K: Debug + Ord, V> Debug for VacantEntry<'_, K, V> {
/// A view into an occupied entry in a `BTreeMap`. /// A view into an occupied entry in a `BTreeMap`.
/// It is part of the [`Entry`] enum. /// It is part of the [`Entry`] enum.
///
/// [`Entry`]: enum.Entry.html
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub struct OccupiedEntry<'a, K: 'a, V: 'a> { pub struct OccupiedEntry<'a, K: 'a, V: 'a> {
handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV>, handle: Handle<NodeRef<marker::Mut<'a>, K, V, marker::LeafOrInternal>, marker::KV>,
@ -815,7 +811,7 @@ impl<K: Ord, V> BTreeMap<K, V> {
/// types that can be `==` without being identical. See the [module-level /// types that can be `==` without being identical. See the [module-level
/// documentation] for more. /// documentation] for more.
/// ///
/// [module-level documentation]: index.html#insert-and-complex-keys /// [module-level documentation]: crate::collections#insert-and-complex-keys
/// ///
/// # Examples /// # Examples
/// ///
@ -2554,7 +2550,7 @@ impl<'a, K: Ord, V> OccupiedEntry<'a, K, V> {
/// If you need a reference to the `OccupiedEntry` that may outlive the /// If you need a reference to the `OccupiedEntry` that may outlive the
/// destruction of the `Entry` value, see [`into_mut`]. /// destruction of the `Entry` value, see [`into_mut`].
/// ///
/// [`into_mut`]: #method.into_mut /// [`into_mut`]: OccupiedEntry::into_mut
/// ///
/// # Examples /// # Examples
/// ///
@ -2584,7 +2580,7 @@ impl<'a, K: Ord, V> OccupiedEntry<'a, K, V> {
/// ///
/// If you need multiple references to the `OccupiedEntry`, see [`get_mut`]. /// If you need multiple references to the `OccupiedEntry`, see [`get_mut`].
/// ///
/// [`get_mut`]: #method.get_mut /// [`get_mut`]: OccupiedEntry::get_mut
/// ///
/// # Examples /// # Examples
/// ///

2
library/alloc/src/collections/linked_list.rs
View file

@ -102,7 +102,7 @@ impl<T: fmt::Debug> fmt::Debug for IterMut<'_, T> {
/// This `struct` is created by the [`into_iter`] method on [`LinkedList`] /// This `struct` is created by the [`into_iter`] method on [`LinkedList`]
/// (provided by the `IntoIterator` trait). See its documentation for more. /// (provided by the `IntoIterator` trait). See its documentation for more.
/// ///
/// [`into_iter`]: struct.LinkedList.html#method.into_iter /// [`into_iter`]: LinkedList::into_iter
#[derive(Clone)] #[derive(Clone)]
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub struct IntoIter<T> { pub struct IntoIter<T> {