From d164793c40f92287fd6a59c120139569a807b130 Mon Sep 17 00:00:00 2001 Message-Id: From: Mark Wooding Date: Sat, 25 Mar 2017 17:59:39 +0000 Subject: [PATCH] src/final.lisp (test-module): Fix egregiously wrong docstring. Organization: Straylight/Edgeware From: Mark Wooding Make the doc stub match too. --- doc/misc.tex | 2 +- src/final.lisp | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/misc.tex b/doc/misc.tex index 8b7536c..f43ec98 100644 --- a/doc/misc.tex +++ b/doc/misc.tex @@ -568,7 +568,7 @@ These symbols are defined in the @!optparse| package. \begin{describe}{var}{*debugout-pathname*} \end{describe} -\begin{describe}{fun}{test-module @ @} +\begin{describe}{fun}{test-module @ @ @> @} \end{describe} \begin{describe}{fun} diff --git a/src/final.lisp b/src/final.lisp index ee75705..6b81e3d 100644 --- a/src/final.lisp +++ b/src/final.lisp @@ -40,8 +40,13 @@ (defvar *debugout-pathname* #p"debugout.c") (export 'test-module) (defun test-module (path reason) - "Reset the translator's state, read a module from PATH and output it with - REASON, returning the result as a string." + "Read a module from PATH, to exercise the machinery. + + If REASON is non-nil, then output the module to `*debugout-pathname*' with + that REASON. + + Return a two-element list (NERROR NWARNING) of the number of errors and + warnings encountered while processing the module." (multiple-value-bind (module nerror nwarning) (count-and-report-errors () (read-module path)) (when reason -- [mdw]