Added doc comments for Poem::recite()

Added documentation comments for the Poem::recite() function, detailing
what the purpose of the function is, as well as what operations it
performs.

1 files changed, 8 insertions, 0 deletions

diff --git a/src/poem/recite.rs b/src/poem/recite.rs
index 2311352..ffa97bf 100644
--- a/src/poem/recite.rs
+++ b/src/poem/recite.rs
@@ -15,6 +15,14 @@ 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
+    /// [Stanza].
     fn recite(&self, env: &mut Environment) -> Result<Vec<u8>, io::Error> {
         // Variable for storing the output of a piped verse
         let mut out: Vec<u8> = Vec::new();