Misleading comment in `Modules/xxmodule.c`

[nybblista]

Everything is clear on how to use xxmodule.c as a starting point to build your own module based on the explanation on the file itself, but I feel confused with the following portion of the comments at the header:

If your object type is needed in other files, you'll have to create a file "foobarobject.h"..

Before that there is the following:

If your module is named foo your sourcefile should be named foomodule.c

Which is clear from the name of the file itself xxmodule.c.

Do we have typo here for bar? or it is just another way to say use the module name + anything + object?

cpython/Modules/xxmodule.c

Line 12 in d66b061

other files, you'll have to create a file "foobarobject.h"; see

Linked PRs

• gh-122040: Reword Modules/xxmodule.c module-level comment #132201
• [3.13] gh-122040: reword Modules/xxmodule.c module-level comment (GH-132201) #132207
• [3.12] gh-122040: reword Modules/xxmodule.c module-level comment (GH-132201) #132208

[picnixz]

I think the "foobarobject" is because it's the bar object in the foo module. For your personal projects, I don't think there should be any naming constraints as for how you name the files (the only restriction is on the exported function PyInit_*).

[picnixz]

@ncoghlan or @encukou Maybe you want to say something else on this topic?

[encukou]

The comment predates me, but I think the filename is just an example.
Would just …you'll also have to create a header file for it. work? I don't think floatobject.h is a good example any more.