mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-23 11:15:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Document GetoptError and label error an alias.

Browse source
This commit is contained in:
Fred Drake 1999-12-21 22:50:05 +00:00
parent 80c33e562d
commit 76e6da38c0
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/lib/libgetopt.tex
View file

@ -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}