bpo-32124: C API preinit doc, change note formatting#4621
bpo-32124: C API preinit doc, change note formatting#4621vstinner wants to merge 1 commit intopython:masterfrom vstinner:capi_preinit2
Conversation
Format the list of functions that should not be called before Py_Initialize() as a list, rather than a note.
| On the contrary, the following functions **should not be called** before | ||
| :c:func:`Py_Initialize`: | ||
|
|
||
| * :c:func:`Py_EncodeLocale` |
There was a problem hiding this comment.
I'm not sure this would look better. The list takes more space and attracts more attention (and distract it from the above lists). This list is less important than above lists. Actually the list of functions that should not be called before Py_Initialize() is much longer. ;-) Here are just functions that look similar to functions in the above lists.
There was a problem hiding this comment.
But removing the "note" directive LGTM.
There was a problem hiding this comment.
Maybe we need a distinct section for this list?
|
yes |
|
@ericsnowcurrently: I wrote this PR to address on your comment in my previous PR, but @serhiy-storchaka doesn't like it. So, what do you think? I wrote functions that must not be called before Py_Initialize() as a sentence in a note, to not confuse users, since the sections described functions safe to call before Py_Initialize()... |
|
I dislike the new style of the note as Serhiy, and Eric Snow doesn't reply, so I close this PR. |
5 participants
Format the list of functions that should not be called before
Py_Initialize() as a list, rather than a note.
https://bugs.python.org/issue32124