summaryrefslogtreecommitdiffstats
path: root/src/recite/ps.rs
diff options
context:
space:
mode:
authorRory Dudley2024-02-28 23:04:51 -0700
committerRory Dudley2024-02-28 23:04:51 -0700
commit75407774ce163df53c28391fb653c3714abd1aef (patch)
tree1096b9b4b82fff29195a4f9d543aedea0b08e2b7 /src/recite/ps.rs
parent55e9a27bde60a8e4fbb6306871b6317d68685987 (diff)
downloaddwarvish-75407774ce163df53c28391fb653c3714abd1aef.tar.gz
Fix ps macros doc comments
[Verse] is not in scope for the ps module, so removed the link in the documentation comments.
Diffstat (limited to 'src/recite/ps.rs')
-rw-r--r--src/recite/ps.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/recite/ps.rs b/src/recite/ps.rs
index 431466e..d0e2435 100644
--- a/src/recite/ps.rs
+++ b/src/recite/ps.rs
@@ -1,7 +1,7 @@
#[macro_export]
-/// Fork into a process from a [Verse]
+/// Fork into a process from a Verse
///
-/// Figures out whether or not the given [Verse] is a couplet. If it is, fork
+/// Figures out whether or not the given Verse is a couplet. If it is, fork
/// into a process, and pipe the contents of out `out` into STDIN. If not, then
/// simply fork into the process.
///
@@ -27,12 +27,12 @@ macro_rules! task {
};
}
-/// Fork into a process from a [Verse], and capture STDOUT
+/// Fork into a process from a Verse, and capture STDOUT
///
-/// Figures out whether or not the given [Verse] is a couplet. If it is, fork
+/// Figures out whether or not the given Verse is a couplet. If it is, fork
/// into a process, and pipe the contents of out `out` into STDIN. If not, then
/// simply fork into the process. Additionally, this function will capture
-/// STDOUT of the process specified by the [Verse], and store it in `out`.
+/// STDOUT of the process specified by the Verse, and store it in `out`.
///
/// # Arguments
/// * `$verse: &Verse` - The verse to fork into