summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libposixfile.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-04-21 21:15:35 (GMT)
committerFred Drake <fdrake@acm.org>1999-04-21 21:15:35 (GMT)
commitd146edfaf1cae84cf9f4d3505279c8618722397c (patch)
treee420855cec301ee4568fa7863f53d3de27dd8021 /Doc/lib/libposixfile.tex
parentb11d108cdc8890795d2341db84b90dc7bcce7a5b (diff)
downloadcpython-d146edfaf1cae84cf9f4d3505279c8618722397c.zip
cpython-d146edfaf1cae84cf9f4d3505279c8618722397c.tar.gz
cpython-d146edfaf1cae84cf9f4d3505279c8618722397c.tar.bz2
Mark the "Notes:" sections under tables the same way it's done
elsewhere in the library reference.
Diffstat (limited to 'Doc/lib/libposixfile.tex')
-rw-r--r--Doc/lib/libposixfile.tex16
1 files changed, 11 insertions, 5 deletions
diff --git a/Doc/lib/libposixfile.tex b/Doc/lib/libposixfile.tex
index b5c4451..d3445f7 100644
--- a/Doc/lib/libposixfile.tex
+++ b/Doc/lib/libposixfile.tex
@@ -11,7 +11,7 @@
\indexii{\POSIX{}}{file object}
-\emph{Note:} This module will become obsolete in a future release.
+\strong{Note:} This module will become obsolete in a future release.
The locking operation that it provides is done better and more
portably by the \function{fcntl.lockf()} call.%
\withsubitem{(in module fcntl)}{\ttindex{lockf()}}
@@ -123,12 +123,15 @@ In addition the following modifiers can be added to the format:
\code{None} if there is no conflict.}{(1)}
\end{tableiii}
+\noindent
Note:
-(1) The lock returned is in the format \code{(\var{mode}, \var{len},
+\begin{description}
+\item[(1)] The lock returned is in the format \code{(\var{mode}, \var{len},
\var{start}, \var{whence}, \var{pid})} where \var{mode} is a character
representing the type of lock ('r' or 'w'). This modifier prevents a
request from being granted; it is for query purposes only.
+\end{description}
Format characters for the \method{flags()} method have the following
meanings:
@@ -149,12 +152,15 @@ In addition the following modifiers can be added to the format:
are set.}{(2)}
\end{tableiii}
-Note:
+\noindent
+Notes:
-(1) The \samp{!} and \samp{=} modifiers are mutually exclusive.
+\begin{description}
+\item[(1)] The \samp{!} and \samp{=} modifiers are mutually exclusive.
-(2) This string represents the flags after they may have been altered
+\item[(2)] This string represents the flags after they may have been altered
by the same call.
+\end{description}
Examples: