summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorSoniEx2 <endermoneymod@gmail.com>2022-05-07 21:59:38 -0300
committerSoniEx2 <endermoneymod@gmail.com>2022-05-07 22:00:40 -0300
commit21a52ac06f851aceb76bcfc6d1475514e3227b49 (patch)
tree13a461ccb63a56984a4479312e7f14a84cf601f8
parent1514dae7d35bf294efd0f8878562409c25ff1259 (diff)
Attempt to improve crate docs
-rw-r--r--Cargo.toml2
-rw-r--r--src/lib.rs12
2 files changed, 11 insertions, 3 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 1c469f5..8927c06 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "ltptr"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 license = "CC0-1.0"
 description = "Checked raw pointers."
diff --git a/src/lib.rs b/src/lib.rs
index 0b1837d..42eb51b 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -6,6 +6,14 @@
 //! doing FFI interactions. A non-insignificant portion of them came from raw
 //! pointers, `as_ptr`, `as_mut_ptr`, and the like. This removes that cognitive
 //! overhead.
+//!
+//! And as [Amos once said], "Until we demand better of our tools, we are
+//! doomed to be woken up in the middle of the night, over and over again,
+//! because some nil value slipped in where it never should have.". That is, we
+//! are doomed to repeat the same mistakes over and over again. So we must
+//! demand better of our tools!
+//!
+//! [Amos once said]: https://fasterthanli.me/articles/lies-we-tell-ourselves-to-keep-using-golang
 
 use core::cell::UnsafeCell;
 use core::marker::PhantomData;
@@ -107,14 +115,14 @@ pub trait AsMutLtPtr: AsLtPtr {
 pub trait SliceExt<T>: impls::slice::Sealed {
     /// Returns the two raw pointers spanning the slice.
     ///
-    /// See [`[T]::as_ptr_range`] for extended documentation.
+    /// See [`slice::as_ptr_range`] for extended documentation.
     ///
     /// The pointers returned by this function have bound lifetimes.
     fn as_lt_ptr_range<'a>(&'a self) -> Range<ConstLtPtr<'a, T>>;
 
     /// Returns the two unsafe mutable pointers spanning the slice.
     ///
-    /// See [`[T]::as_mut_ptr_range`] for extended documentation.
+    /// See [`slice::as_mut_ptr_range`] for extended documentation.
     ///
     /// The pointers returned by this function have bound lifetimes.
     fn as_mut_lt_ptr_range<'a>(&'a mut self) -> Range<MutLtPtr<'a, T>>;