about summary refs log tree commit diff
path: root/library/std/src/error.rs
diff options
context:
space:
mode:
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>2022-08-22 11:45:40 +0530
committerGitHub <noreply@github.com>2022-08-22 11:45:40 +0530
commita4950ef7eb1bc72ede47775deea4018c7b62d40a (patch)
treefc58a8cbd250c84e6d6327f77457c520bf7259f4 /library/std/src/error.rs
parentd0ea1d767925d53b2230e2ba81197821514781f0 (diff)
parent17ddcb434b8fca7eeb865985942b146647a3510f (diff)
downloadrust-a4950ef7eb1bc72ede47775deea4018c7b62d40a.tar.gz
rust-a4950ef7eb1bc72ede47775deea4018c7b62d40a.zip
Rollup merge of #93162 - camsteffen:std-prim-docs, r=Mark-Simulacrum
Std module docs improvements

My primary goal is to create a cleaner separation between primitive types and primitive type helper modules (fixes #92777). I also changed a few header lines in other top-level std modules (seen at https://doc.rust-lang.org/std/) for consistency.

Some conventions used/established:

 * "The \`Box\<T>` type for heap allocation." - if a module mainly provides a single type, name it and summarize its purpose in the module header
 * "Utilities for the _ primitive type." - this wording is used for the header of helper modules
 * Documentation for primitive types themselves are removed from helper modules
 * provided-by-core functionality of primitive types is documented in the primitive type instead of the helper module (such as the "Iteration" section in the slice docs)

I wonder if some content in `std::ptr` should be in `pointer` but I did not address this.
Diffstat (limited to 'library/std/src/error.rs')
-rw-r--r--library/std/src/error.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/library/std/src/error.rs b/library/std/src/error.rs
index df7a49d2582..4fbcfd85d7c 100644
--- a/library/std/src/error.rs
+++ b/library/std/src/error.rs
@@ -1,4 +1,4 @@
-//! Interfaces for working with Errors.
+//! The `Error` trait provides common functionality for errors.
 //!
 //! # Error Handling In Rust
 //!