Merge pull request #67 from grovesNL/add-docs

Fill out some more docs

src/attrs.rs

@@ -52,6 +52,7 @@ impl Color {
     }
 }
 
+/// An owned version of [`Family`]
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub enum FamilyOwned {
     Name(String),
@@ -177,6 +178,7 @@ impl<'a> Attrs<'a> {
     }
 }
 
+/// An owned version of [`Attrs`]
 #[derive(Clone, Debug, Eq, Hash, PartialEq)]
 pub struct AttrsOwned {
     //TODO: should this be an option?

src/buffer.rs

@@ -40,6 +40,7 @@ impl Cursor {
     }
 }
 
+/// Whether to associate cursors placed at a boundary between runs with the run before or after it.
 #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
 pub enum Affinity {
     Before,
@@ -78,6 +79,7 @@ impl Default for Affinity {
     }
 }
 
+/// The position of a cursor within a [`Buffer`].
 pub struct LayoutCursor {
     pub line: usize,
     pub layout: usize,

src/font/mod.rs

@@ -10,6 +10,7 @@ mod matches;
 pub use self::system::*;
 mod system;
 
+/// A font
 pub struct Font<'a> {
     pub info: &'a fontdb::FaceInfo,
     pub data: &'a [u8],

src/lib.rs

@@ -56,15 +56,15 @@
 
 // Not interested in these lints
 #![allow(clippy::new_without_default)]
-// TODO: address ocurrances and then deny
+// TODO: address occurrences and then deny
 //
 // Indexing a slice can cause panics and that is something we always want to avoid
 #![allow(clippy::indexing_slicing)]
 // Overflows can produce unpredictable results and are only checked in debug builds
 #![allow(clippy::integer_arithmetic)]
 // Soundness issues
 //
-// Dereferencing unalinged pointers may be undefined behavior
+// Dereferencing unaligned pointers may be undefined behavior
 #![deny(clippy::cast_ptr_alignment)]
 // Avoid panicking in without information about the panic. Use expect
 #![deny(clippy::unwrap_used)]