is_zipfile() description: Use the same name for the parameter as the

code, in case someone wants to use it as a keyword paramter.

ZIP_DEFLATED description:  Do not reveal the specific value of the
      constant, since code should only use the symbolic name.
This commit is contained in:
Fred Drake 2000-10-06 15:29:56 +00:00
parent 50a22a4cad
commit 5d63a39983
1 changed files with 3 additions and 3 deletions

View File

@ -47,14 +47,14 @@ The available attributes of this module are:
are described in section \ref{zipinfo-objects}, ``ZipInfo Objects.''
\end{classdesc}
\begin{funcdesc}{is_zipfile}{path}
Returns true if \var{path} is a valid ZIP file based on its magic
\begin{funcdesc}{is_zipfile}{filename}
Returns true if \var{filename} is a valid ZIP file based on its magic
number, otherwise returns false. This module does not currently
handle ZIP files which have appended comments.
\end{funcdesc}
\begin{datadesc}{ZIP_STORED}
The numeric constant (\code{0}) for an uncompressed archive member.
The numeric constant for an uncompressed archive member.
\end{datadesc}
\begin{datadesc}{ZIP_DEFLATED}