[Patches] [ python-Patches-798638 ] Improve "veryhigh.tex" API docs

[SourceForge.net]

Patches item #798638, was opened at 2003-09-01 12:11
Message generated for change (Comment added) made by fdrake
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=798638&group_id=5470

Category: Documentation
Group: None
>Status: Closed
>Resolution: Accepted
Priority: 5
Submitted By: Jeff Epler (jepler)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Improve "veryhigh.tex" API docs

Initial Comment:
Many variant versions of functions were not documented in this chapter, and the PyCompilerFlags structure was not documented at all.

This patch fixes that.  It adds documentation for:
+\begin{cfuncdesc}{int}{PyRun_AnyFileFlags}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{int}{PyRun_AnyFileEx}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{int}{PyRun_AnyFileExFlags}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{int}{PyRun_SimpleStringFlags}{const char *command,
+\begin{cfuncdesc}{int}{PyRun_SimpleFileFlags}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{int}{PyRun_SimpleFileEx}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{int}{PyRun_SimpleFileExFlags}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{int}{PyRun_InteractiveOneFlags}{FILE *fp,
+\begin{cfuncdesc}{int}{PyRun_InteractiveLoopFlags}{FILE *fp, 
+\begin{cfuncdesc}{struct _node*}{PyParser_SimpleParseStringFlags}{
+\begin{cfuncdesc}{struct _node*}{PyParser_SimpleParseStringFlagsFilename}{
+\begin{cfuncdesc}{struct _node*}{PyParser_SimpleParseFileFlags}{FILE *fp,
+\begin{cfuncdesc}{PyObject*}{PyRun_StringFlags}{const char *str, int start,
+\begin{cfuncdesc}{PyObject*}{PyRun_FileEx}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{PyObject*}{PyRun_FileFlags}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{PyObject*}{PyRun_FileExFlags}{FILE *fp, const char *filename,
+\begin{cfuncdesc}{PyObject*}{Py_CompileStringFlags}{char *str,
+\begin{ctypedesc}[PyCompilerFlags]{struct PyCompilerFlags}
+\begin{cvardesc}{int}{CO_FUTURE_DIVISION}

This patch also reflects the "const"ness of arguments to these functions.

latex seemed to process the modified documentation just fine.

----------------------------------------------------------------------

>Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2004-03-25 10:56

Message:
Logged In: YES 
user_id=3066

Committed a slightly modified version of the patch as
Doc/api/veryhigh.tex 1.2.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=798638&group_id=5470