This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Docs point to FAQ Section 3, but FAQs are not numbered
Type: Stage: resolved
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: docs@python Nosy List: brian.curtin, docs@python, eric.araujo, stutzbach, terry.reedy, tim.golden
Priority: normal Keywords:

Created on 2010-09-01 01:49 by stutzbach, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (8)
msg115285 - (view) Author: Daniel Stutzbach (stutzbach) (Python committer) Date: 2010-09-01 01:49
In Doc/extending/windows.rst, there's the following text:

------------------------------------------------------------------------
If your module creates a new type, you may have trouble with this line::

   PyVarObject_HEAD_INIT(&PyType_Type, 0)

Change it to::

   PyVarObject_HEAD_INIT(NULL, 0)

and add the following to the module initialization function::

   MyObject_Type.ob_type = &PyType_Type;

Refer to section 3 of the `Python FAQ <http://www.python.org/doc/faq>`_ for
details on why you must do this.
------------------------------------------------------------------------

If I assume that Section 3 means, the third link on the FAQ page, I can't find the FAQ that's being alluded to here.  There's a comment in Include/pyport.h that I believe to be related:

            /* Under Cygwin, auto-import functions to prevent compilation */
            /* failures similar to http://python.org/doc/FAQ.html#3.24 */

However, that link no longer goes to a particular question and I can't tell which question it once referred to.

I ran into this because I'm trying to understand the cause of the issue which I suspect is related to Issue #6672.
msg115493 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2010-09-03 19:54
As I remember, the FAQ was once that, *the* (giant) FAQ, with numbered sections. When broken into pieces, the order may have been re-arranged.

Given that the broken reference is in extending/windows, I would look in both the Extending and Windows FAQs. However, I found neither 'PyType_Type' nor 'PyVarObject_HEAD_INIT' nor 'initialization' in either.

Besides removing the dead reference, you could either look through the revision history of the file or ask on pydev if you need the info.

The split-up FAQs first appear in a release doc set in Python 2.6.4, documentation released on 25 October 2009. I do not know if the earlier, unitary FAQ is in the repository or not.
msg116136 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-09-12 00:00
I tried to find the old FAQ in the Debian package for 2.5 but failed.  It looks like this require a fair bit of version control exploration.
msg116404 - (view) Author: Daniel Stutzbach (stutzbach) (Python committer) Date: 2010-09-14 15:33
Where does/did the FAQ live in the version control tree?
msg116405 - (view) Author: Daniel Stutzbach (stutzbach) (Python committer) Date: 2010-09-14 15:47
It looks like the FAQ used be generated using Tools/faqwiz/faqwiz.py (which no longer exists).  According to that file:

-----------------------------------------------------------------------
This is a CGI program that maintains a user-editable FAQ.  It uses RCS
to keep track of changes to individual FAQ entries.  It is fully
configurable; everything you might want to change when using this
program to maintain some other FAQ than the Python FAQ is contained in
the configuration module, faqconf.py.
-----------------------------------------------------------------------

In other words, while the FAQ was under version control, it wasn't the regular repository.

I'll ask on python-dev is anyone has a copy.
msg116406 - (view) Author: Daniel Stutzbach (stutzbach) (Python committer) Date: 2010-09-14 15:49
Nevermind... archive.org has it. :-)
msg116407 - (view) Author: Daniel Stutzbach (stutzbach) (Python committer) Date: 2010-09-14 16:11
Fixed in r84810, r84811, and 84812.

For anyone curious, the old FAQ entry is here:
http://web.archive.org/web/20010203161100/http://www.python.org/doc/FAQ.html#3.24
msg116420 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-09-14 21:22
Thanks for the investigation!
History
Date User Action Args
2022-04-11 14:57:05adminsetgithub: 53937
2010-09-14 21:22:05eric.araujosetmessages: + msg116420
2010-09-14 16:11:07stutzbachsetstatus: open -> closed
versions: + Python 3.1, Python 2.7, Python 3.2
messages: + msg116407

resolution: accepted
stage: needs patch -> resolved
2010-09-14 15:49:09stutzbachsetmessages: + msg116406
2010-09-14 15:47:36stutzbachsetmessages: + msg116405
2010-09-14 15:33:49stutzbachsetmessages: + msg116404
2010-09-12 00:00:54eric.araujosetnosy: + eric.araujo
messages: + msg116136
2010-09-03 19:54:50terry.reedysetnosy: + terry.reedy
messages: + msg115493
2010-09-01 01:49:07stutzbachcreate