comparison scripts/testfun/fail.m @ 9051:1bf0ce0930be

Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents eb63fbe60fab
children 95c3e38098bf
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
22 ## -*- texinfo -*- 22 ## -*- texinfo -*-
23 ## @deftypefn {Function File} {} fail (@var{code},@var{pattern}) 23 ## @deftypefn {Function File} {} fail (@var{code},@var{pattern})
24 ## @deftypefnx {Function File} {} fail (@var{code},'warning',@var{pattern}) 24 ## @deftypefnx {Function File} {} fail (@var{code},'warning',@var{pattern})
25 ## 25 ##
26 ## Return true if @var{code} fails with an error message matching 26 ## Return true if @var{code} fails with an error message matching
27 ## @var{pattern}, otherwise produce an error. Note that @var{code} 27 ## @var{pattern}, otherwise produce an error. Note that @var{code}
28 ## is a string and if @var{code} runs successfully, the error produced is: 28 ## is a string and if @var{code} runs successfully, the error produced is:
29 ## 29 ##
30 ## @example 30 ## @example
31 ## expected error but got none 31 ## expected error but got none
32 ## @end example 32 ## @end example
33 ## 33 ##
34 ## If the code fails with a different error, the message produced is: 34 ## If the code fails with a different error, the message produced is:
35 ## 35 ##
36 ## @example 36 ## @example
37 ## @group
37 ## expected <pattern> 38 ## expected <pattern>
38 ## but got <text of actual error> 39 ## but got <text of actual error>
40 ## @end group
39 ## @end example 41 ## @end example
40 ## 42 ##
41 ## The angle brackets are not part of the output. 43 ## The angle brackets are not part of the output.
42 ## 44 ##
43 ## Called with three arguments, the behavior is similar to 45 ## Called with three arguments, the behavior is similar to