Skip to content

Commit d3304c8

Browse files
authored
Rollup merge of #81588 - xfix:delete-doc-alias, r=Mark-Simulacrum
Add doc aliases for "delete" This patch adds doc aliases for "delete". The added aliases are supposed to reference usages `delete` in other programming languages. - `HashMap::remove`, `BTreeMap::remove` -> `Map#delete` and `delete` keyword in JavaScript. - `HashSet::remove`, `BTreeSet::remove` -> `Set#delete` in JavaScript. - `mem::drop` -> `delete` keyword in C++. - `fs::remove_file`, `fs::remove_dir`, `fs::remove_dir_all`-> `File#delete` in Java, `File#delete` and `Dir#delete` in Ruby. Before this change, searching for "delete" in documentation returned no results.
2 parents 3aed8b1 + 15701f7 commit d3304c8

File tree

6 files changed

+8
-0
lines changed

6 files changed

+8
-0
lines changed

library/alloc/src/collections/btree/map.rs

+1
Original file line numberDiff line numberDiff line change
@@ -823,6 +823,7 @@ impl<K: Ord, V> BTreeMap<K, V> {
823823
/// assert_eq!(map.remove(&1), Some("a"));
824824
/// assert_eq!(map.remove(&1), None);
825825
/// ```
826+
#[doc(alias = "delete")]
826827
#[stable(feature = "rust1", since = "1.0.0")]
827828
pub fn remove<Q: ?Sized>(&mut self, key: &Q) -> Option<V>
828829
where

library/alloc/src/collections/btree/set.rs

+1
Original file line numberDiff line numberDiff line change
@@ -770,6 +770,7 @@ impl<T: Ord> BTreeSet<T> {
770770
/// assert_eq!(set.remove(&2), true);
771771
/// assert_eq!(set.remove(&2), false);
772772
/// ```
773+
#[doc(alias = "delete")]
773774
#[stable(feature = "rust1", since = "1.0.0")]
774775
pub fn remove<Q: ?Sized>(&mut self, value: &Q) -> bool
775776
where

library/core/src/mem/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -889,6 +889,7 @@ pub fn replace<T>(dest: &mut T, mut src: T) -> T {
889889
/// ```
890890
///
891891
/// [`RefCell`]: crate::cell::RefCell
892+
#[doc(alias = "delete")]
892893
#[inline]
893894
#[stable(feature = "rust1", since = "1.0.0")]
894895
pub fn drop<T>(_x: T) {}

library/std/src/collections/hash/map.rs

+1
Original file line numberDiff line numberDiff line change
@@ -859,6 +859,7 @@ where
859859
/// assert_eq!(map.remove(&1), Some("a"));
860860
/// assert_eq!(map.remove(&1), None);
861861
/// ```
862+
#[doc(alias = "delete")]
862863
#[inline]
863864
#[stable(feature = "rust1", since = "1.0.0")]
864865
pub fn remove<Q: ?Sized>(&mut self, k: &Q) -> Option<V>

library/std/src/collections/hash/set.rs

+1
Original file line numberDiff line numberDiff line change
@@ -874,6 +874,7 @@ where
874874
/// assert_eq!(set.remove(&2), true);
875875
/// assert_eq!(set.remove(&2), false);
876876
/// ```
877+
#[doc(alias = "delete")]
877878
#[inline]
878879
#[stable(feature = "rust1", since = "1.0.0")]
879880
pub fn remove<Q: ?Sized>(&mut self, value: &Q) -> bool

library/std/src/fs.rs

+3
Original file line numberDiff line numberDiff line change
@@ -1524,6 +1524,7 @@ impl AsInner<fs_imp::DirEntry> for DirEntry {
15241524
/// Ok(())
15251525
/// }
15261526
/// ```
1527+
#[doc(alias = "delete")]
15271528
#[stable(feature = "rust1", since = "1.0.0")]
15281529
pub fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
15291530
fs_imp::unlink(path.as_ref())
@@ -1958,6 +1959,7 @@ pub fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
19581959
/// Ok(())
19591960
/// }
19601961
/// ```
1962+
#[doc(alias = "delete")]
19611963
#[stable(feature = "rust1", since = "1.0.0")]
19621964
pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
19631965
fs_imp::rmdir(path.as_ref())
@@ -1995,6 +1997,7 @@ pub fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
19951997
/// Ok(())
19961998
/// }
19971999
/// ```
2000+
#[doc(alias = "delete")]
19982001
#[stable(feature = "rust1", since = "1.0.0")]
19992002
pub fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
20002003
fs_imp::remove_dir_all(path.as_ref())

0 commit comments

Comments
 (0)