unofficial mirror of gwl-devel@gnu.org
 help / color / mirror / Atom feed
From: Kyle Meyer <kyle@kyleam.com>
To: gwl-devel@gnu.org
Cc: Kyle Meyer <kyle@kyleam.com>
Subject: [PATCH] Touch up a few docstrings.
Date: Wed, 12 Jun 2019 21:32:27 -0400	[thread overview]
Message-ID: <20190613013227.1693618-1-kyle@kyleam.com> (raw)

* gwl/processes.scm (processes-filter):
* gwl/workflows.scm (auto-connect): Fix typo.
(print-workflow): Rephrase repetitive wording to be consistent with
style of surrounding docstrings.
(workflow-run-order): Convert parameter to upper case.
---
 gwl/processes.scm | 2 +-
 gwl/workflows.scm | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/gwl/processes.scm b/gwl/processes.scm
index c0b594e..735b5e3 100644
--- a/gwl/processes.scm
+++ b/gwl/processes.scm
@@ -535,7 +535,7 @@ (define (process-threads process)
 (define (processes-filter processes filter)
   "Returns a list of PROCESSES after applying FILTER.  FILTER
 is a function that takes a process and returns the process to include it
-of #f to exclude it."
+or #f to exclude it."
   (filter-map filter processes))
 
 (define (processes-filter-by-name processes name)
diff --git a/gwl/workflows.scm b/gwl/workflows.scm
index 50dc2ee..574d23c 100644
--- a/gwl/workflows.scm
+++ b/gwl/workflows.scm
@@ -150,7 +150,7 @@ (define-syntax graph
 
 (define (auto-connect . processes)
   "Return an association list mapping processes to processes they
-depend on.  This is accomplished by matching a the inputs of a process
+depend on.  This is accomplished by matching the inputs of a process
 with the outputs of other processes."
   (let ((process-by-output
          (append-map (lambda (process)
@@ -181,7 +181,7 @@ (define (workflow-full-name workflow)
       (workflow-name workflow)))
 
 (define (print-workflow workflow port)
-  "Write a decent human-representation of a workflow of WORKFLOW to PORT."
+  "Write a decent human-representation of WORKFLOW to PORT."
   (simple-format port "#<workflow ~a>" (workflow-full-name workflow)))
 
 (define* (print-workflow-record workflow #:optional (port #t))
@@ -208,7 +208,7 @@ (define-method (write (workflow <workflow>) port)
 
 (define* (workflow-run-order workflow #:key (parallel? #t))
   "Returns a list of processes in WORKFLOW in the order in which the
-processes can be executed.  When parallel? is set to #T, the list
+processes can be executed.  When PARALLEL? is set to #T, the list
 contains lists of processes that can be executed in parallel."
   (let ((order-function (if parallel?
                             parallel-step-execution-order
-- 
2.22.0

             reply	other threads:[~2019-06-13  1:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-13  1:32 Kyle Meyer [this message]
2019-06-14 19:49 ` [PATCH] Touch up a few docstrings Ricardo Wurmus

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.guixwl.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190613013227.1693618-1-kyle@kyleam.com \
    --to=kyle@kyleam.com \
    --cc=gwl-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).