New submission from Arthur Goldberg:
I've just taught myself how to write C extensions to Python with
https://docs.python.org/3.6/extending/extending.html. I think it's quite good.
Nevertheless, I've some suggested improvements. These all use the vi s///
replacement syntax.
Ambiguous 'it':
s/If the latter header file does not exist on your system, it declares the
functions malloc(), free() and realloc() directly./If the latter header file
does not exist on your system, Python.h declares the functions malloc(), free()
and realloc() directly./
Unclear, as 'The C function' refers to the specific example, whereas 'always
has' implies that this applies to all calls from Python to C:
s/The C function always has two arguments, conventionally/A C function called
by Python always has two arguments, conventionally/
In
PyMODINIT_FUNC
PyInit_spam(void)
{
PyObject *m;
m = PyModule_Create(&spammodule);
if (m == NULL)
return NULL;
SpamError = PyErr_NewException("spam.error", NULL, NULL);
Py_INCREF(SpamError);
PyModule_AddObject(m, "error", SpamError);
return m;
}
remove
m = PyModule_Create(&spammodule);
if (m == NULL)
return NULL;
and replace it with
...
because it won't compile because spammodule has not been described yet on the
page.
Self-contradictory: 'normally always' is an oxymoron.
s/It should normally always be METH_VARARGS or METH_VARARGS | METH_KEYWORDS; a
value of 0 means that an obsolete variant of PyArg_ParseTuple() is used./It
should always be METH_VARARGS or METH_VARARGS | METH_KEYWORDS; however, legacy
code may use 0, which indicates that an obsolete variant of PyArg_ParseTuple()
is being used./
Incomplete: this comment doesn't contain a complete thought
s/module documentation, may be NULL/pointer to a string containing the module's
documentation, or NULL if none is provided/
Provide hyperlink: for user convenience, add a hyperlink to 'Modules/xxmodule.c'
s/included in the Python source distribution as Modules/xxmodule.c/included in
the Python source distribution as Modules/xxmodule.c/
Incomplete: It would be good to lead programmers towards the easiest approach.
s/ If you use dynamic loading,/<new paragraph> If you can use dynamic loading,
the the easiest approach is to use Python's distutils module to build your
module. If you use dynamic loading,/
----------
assignee: docs@python
components: Documentation
messages: 291192
nosy: ArthurGoldberg, docs@python
priority: normal
severity: normal
status: open
title: Suggested changes for
https://docs.python.org/3.6/extending/extending.html
type: behavior
versions: Python 3.6
_______________________________________
Python tracker <[email protected]>
<http://bugs.python.org/issue29997>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe:
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
