[Maxima-commits] CVS: maxima/doc/info Input.texi, 1.49, 1.49.2.1 Help.texi, 1.19, 1.19.8.1

[Robert D. <rob...@us...>]

Update of /cvsroot/maxima/maxima/doc/info
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv8102/doc/info

Modified Files:
      Tag: describe-revision-branch
	Input.texi Help.texi 
Log Message:
Add description of ?! and describe(foo, exact).

Index: Input.texi
===================================================================
RCS file: /cvsroot/maxima/maxima/doc/info/Input.texi,v
retrieving revision 1.49
retrieving revision 1.49.2.1
diff -u -d -r1.49 -r1.49.2.1
--- Input.texi	13 Nov 2006 19:38:21 -0000	1.49
+++ Input.texi	28 Nov 2006 06:35:34 -0000	1.49.2.1
@@ -303,7 +303,21 @@
 See @ref{Lisp and Maxima} for more on this point.
 
 The notation @code{? word} (a question mark followed a word, separated by whitespace)
-is equivalent to @code{describe ("word")}.
+is equivalent to @code{describe("word")}.
+The question mark must occur at the beginning of an input line;
+otherwise it is not recognized as a request for documentation.
+
+@end deffn
+
+@deffn {Special symbol} ?!
+@ifinfo
+@fnindex Fetch documentation (exact search)
+@end ifinfo
+
+The notation @code{?! word} (@code{?!} followed a word, separated by whitespace)
+is equivalent to @code{describe("word", exact)}.
+The question mark must occur at the beginning of an input line;
+otherwise it is not recognized as a request for documentation.
 
 @end deffn
 

Index: Help.texi
===================================================================
RCS file: /cvsroot/maxima/maxima/doc/info/Help.texi,v
retrieving revision 1.19
retrieving revision 1.19.8.1
diff -u -d -r1.19 -r1.19.8.1
--- Help.texi	27 Jun 2005 14:25:15 -0000	1.19
+++ Help.texi	28 Nov 2006 06:35:34 -0000	1.19.8.1
@@ -321,16 +321,24 @@
 @end deffn
 
 @deffn {Function} describe (@var{string})
-Finds all documented items which contain @var{string} in their titles.
+@deffnx {Function} describe (@var{string}, exact)
+@code{describe(@var{string})} finds all documented items which contain @var{string} in their titles.
 If there is more than one such item, Maxima asks the user to select
 an item or items to display.
+
+@code{describe(@var{string}, exact)} finds an item with title equal
+(case-insensitive)
+to @var{string}, if there is any such item.
+
 At the interactive prompt,
 @code{? foo} (with a space between @code{?} and @code{foo})
-is equivalent to @code{describe ("foo")}.
+is equivalent to @code{describe("foo")},
+and @code{?! foo} is equivalent to @code{describe("foo", exact)}.
 
-@code{describe ("")} yields a list of all topics documented in the on-line manual.
+@code{describe("")} yields a list of all topics documented in the on-line manual.
 
-@code{describe} quotes its argument. @code{describe} always returns @code{false}.
+@code{describe} quotes its argument.
+@code{describe} returns @code{true} if some documentation is found, otherwise @code{false}.
 
 Example: