Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 76e6da3

Browse files
committed
Document GetoptError and label error an alias.
1 parent 80c33e5 commit 76e6da3

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

Doc/lib/libgetopt.tex

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,19 @@ \section{\module{getopt} ---
4141
be mixed.
4242
\end{funcdesc}
4343

44-
\begin{excdesc}{error}
44+
\begin{excdesc}{GetoptError}
4545
This is raised when an unrecognized option is found in the argument
4646
list or when an option requiring an argument is given none.
4747
The argument to the exception is a string indicating the cause of the
4848
error. For long options, an argument given to an option which does
49-
not require one will also cause this exception to be raised.
49+
not require one will also cause this exception to be raised. The
50+
attributes \member{msg} and \member{opt} give the error message and
51+
related option; if there is no specific option to which the exception
52+
relates, \member{opt} is an empty string.
53+
\end{excdesc}
54+
55+
\begin{excdesc}{error}
56+
Alias for \exception{GetoptError}; for backward compatibility.
5057
\end{excdesc}
5158

5259

0 commit comments

Comments
 (0)