From 76e6da38c0f3e15a23fce4d3137e7a4d6d16607b Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Tue, 21 Dec 1999 22:50:05 +0000 Subject: [PATCH] Document GetoptError and label error an alias. --- Doc/lib/libgetopt.tex | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Doc/lib/libgetopt.tex b/Doc/lib/libgetopt.tex index 72824a7d95..1c17ab5f84 100644 --- a/Doc/lib/libgetopt.tex +++ b/Doc/lib/libgetopt.tex @@ -41,12 +41,19 @@ found, thus allowing multiple occurrences. Long and short options may be mixed. \end{funcdesc} -\begin{excdesc}{error} +\begin{excdesc}{GetoptError} This is raised when an unrecognized option is found in the argument list or when an option requiring an argument is given none. The argument to the exception is a string indicating the cause of the error. For long options, an argument given to an option which does -not require one will also cause this exception to be raised. +not require one will also cause this exception to be raised. The +attributes \member{msg} and \member{opt} give the error message and +related option; if there is no specific option to which the exception +relates, \member{opt} is an empty string. +\end{excdesc} + +\begin{excdesc}{error} +Alias for \exception{GetoptError}; for backward compatibility. \end{excdesc} -- 2.40.0