Add/update doc comments

This patch update a ton of the documentation comments throughout the
codebase, refactoring some areas, and adding new comments to others.

1 files changed, 6 insertions, 5 deletions

diff --git a/src/poem/recite.rs b/src/poem/recite.rs
index 7ceecca..89f71c8 100644
--- a/src/poem/recite.rs
+++ b/src/poem/recite.rs
@@ -17,11 +17,12 @@ pub trait Reciteable {
 impl Reciteable for Poem {
     /// Recite a [Poem]
     ///
-    /// Runs the commands specified in all verses for a given [Poem]. See
-    /// [crate::poem::Verse::incant] for more details on how processes are
-    /// forked. In addition to running each [crate::poem::Verse],
-    /// [Poem::recite] also checks for the presence of environment variables,
-    /// as well as sub-poems, before running the [crate::poem::Verse]'s
+    /// Runs the commands specified in all verses for a given [Poem].
+    /// See [incant()][crate::poem::Verse::incant] for more details on
+    /// how processes are forked. In addition to running each
+    /// [Verse][crate::poem::Verse], [recite()][Poem::recite] also
+    /// checks for the presence of environment variables, as well as
+    /// internal poems, before running the [Verse][crate::poem::Verse]'s
     /// [Stanza].
     fn recite(&self, env: &mut Environment) -> Result<Vec<u8>, io::Error> {
         // Variable for storing the output of a piped verse