Fix some minor nits about the use of \optional in parameter lists.

This commit is contained in:
Fred Drake 2000-09-22 15:46:35 +00:00
parent ff555e383d
commit 4c6d21a790
1 changed files with 4 additions and 4 deletions

View File

@ -49,7 +49,7 @@ first place (otherwise the \pytype{FSSpec} object for the file itself
is returned). is returned).
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{StandardGetFile}{\optional{type, ...}} \begin{funcdesc}{StandardGetFile}{\optional{type, \moreargs}}
Present the user with a standard ``open input file'' Present the user with a standard ``open input file''
dialog. Optionally, you can pass up to four 4-character file types to limit dialog. Optionally, you can pass up to four 4-character file types to limit
the files the user can choose from. The function returns an \pytype{FSSpec} the files the user can choose from. The function returns an \pytype{FSSpec}
@ -57,12 +57,12 @@ object and a flag indicating that the user completed the dialog
without cancelling. without cancelling.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{PromptGetFile}{prompt\optional{, type, ...}} \begin{funcdesc}{PromptGetFile}{prompt\optional{, type, \moreargs}}
Similar to \function{StandardGetFile()} but allows you to specify a Similar to \function{StandardGetFile()} but allows you to specify a
prompt. prompt.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{StandardPutFile}{prompt, \optional{default}} \begin{funcdesc}{StandardPutFile}{prompt\optional{, default}}
Present the user with a standard ``open output file'' Present the user with a standard ``open output file''
dialog. \var{prompt} is the prompt string, and the optional dialog. \var{prompt} is the prompt string, and the optional
\var{default} argument initializes the output file name. The function \var{default} argument initializes the output file name. The function
@ -187,7 +187,7 @@ is returned.
An interface to the \C{} routine \cfunction{GetAliasInfo()}. An interface to the \C{} routine \cfunction{GetAliasInfo()}.
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[Alias]{Update}{file, \optional{file2}} \begin{methoddesc}[Alias]{Update}{file\optional{, file2}}
Update the alias to point to the \var{file} given. If \var{file2} is Update the alias to point to the \var{file} given. If \var{file2} is
present a relative alias will be created. present a relative alias will be created.
\end{methoddesc} \end{methoddesc}