Merge pull request #5 from jhchabran/main

Fix very minor typo mistake + punctuations

Author: SuperAuguste

src/field_parent_ptr.zig

@@ -2,14 +2,14 @@
 //!
 //! When to use:
 //! - When you want to call one function with a unified interface
-//!   whose implementers share common fields
+//!   whose implementers share common fields.
 //!
 //! When not to use:
 //! - If you have a lot of common functions and few / no common fields
-//!   - You could use a vtable
-//!   - You could use an `inline switch`
+//!   - You could use a vtable.
+//!   - You could use an `inline switch`.
 //! - If you want type correctness guarantees at compile time, use
-//!   a type function
+//!   a type function instead.
 
 const std = @import("std");
 

src/inline_switch.zig

@@ -1,10 +1,10 @@
 //! When to use:
-//! - When you don't want runtime overhead
-//! - When you want reasonably strong type correctness guarantees
-//!   - this avoids most runtime errors potentially found in other techniques
+//! - When you don't want runtime overhead.
+//! - When you want reasonably strong type correctness guarantees.
+//!   - This avoids most runtime errors potentially found in other techniques.
 //!
 //! When not to use:
-//! - If you want extensability! This solution is not extensible in any way;
+//! - If you want extensibility! This solution is not extensible in any way, i.e.
 //!   a user would have to modify the structure directly.
 
 const std = @import("std");

src/type_function.zig

@@ -6,24 +6,24 @@
 //! time values and return a type.
 //!
 //! Here, we create an an all-encompassing type function, Contribution,
-//! that given a summarize function and associated types will call that
+//! that given a summarize function and associated types, will call that
 //! function with additional logic.
 //!
 //! Each call to Contribution with unique parameters returns
 //! a unique type.
 //!
 //! When to use:
-//! - When you don't want runtime overhead
-//! - When you want incredibly strong type correctness guarantees
-//!   - this avoids most runtime errors potentially found in other techniques
-//!   - you can also use @compileError to make certain behaviors illegal
-//!     100% at compile time
-//! - When you want your structure to be easily extended from Zig code
+//! - When you don't want runtime overhead.
+//! - When you want incredibly strong type correctness guarantees.
+//!   - This avoids most runtime errors potentially found in other techniques.
+//!   - You can also use @compileError to make certain behaviors illegal
+//!     100% at compile time.
+//! - When you want your structure to be easily extended from Zig code.
 //!
 //! When not to use:
 //! - If you want to store all instances in a variable of a single type
 //!   (there is no single type like in the vtable or @fieldParentPtr examples,
-//!    so this is not possible)
+//!    so this is not possible).
 
 const std = @import("std");
 

src/vtable.zig

@@ -3,9 +3,9 @@
 //!   with very few / no common fields.
 //!
 //! When not to use:
-//! - If you have a lot of common fields, you could use `@fieldParentPtr`
+//! - If you have a lot of common fields, you could use `@fieldParentPtr` instead.
 //! - If you have only one common function, you could replace the vtable pointer
-//!   with a function pointer (I'd call this a "type erased")
+//!   with a function pointer (I'd call this a "type erased").
 
 const std = @import("std");