Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor change to https://docs.python.org/3.6/extending/building.html #74188

Closed
artgoldberg mannequin opened this issue Apr 6, 2017 · 2 comments
Closed

Minor change to https://docs.python.org/3.6/extending/building.html #74188

artgoldberg mannequin opened this issue Apr 6, 2017 · 2 comments
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error

Comments

@artgoldberg
Copy link
Mannequin

artgoldberg mannequin commented Apr 6, 2017

BPO 30002
Nosy @rhettinger, @artgoldberg

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2017-04-06.02:29:36.069>
labels = ['type-bug', 'docs']
title = 'Minor change to https://docs.python.org/3.6/extending/building.html'
updated_at = <Date 2017-04-06.02:43:59.731>
user = 'https://github.com/artgoldberg'

bugs.python.org fields:

activity = <Date 2017-04-06.02:43:59.731>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2017-04-06.02:29:36.069>
creator = 'ArthurGoldberg'
dependencies = []
files = []
hgrepos = []
issue_num = 30002
keywords = []
message_count = 2.0
messages = ['291203', '291204']
nosy_count = 3.0
nosy_names = ['rhettinger', 'docs@python', 'ArthurGoldberg']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue30002'
versions = ['Python 3.6']

@artgoldberg
Copy link
Mannequin Author

artgoldberg mannequin commented Apr 6, 2017

The core example on this page starts:

from distutils.core import setup, Extension

module1 = Extension('demo',
                    sources = ['demo.c'])

...

I suggest that 'sources = ['demo.c']' be changed to 'sources = ['demomodule.c']', because this would make the example consistent with https://docs.python.org/3.6/extending/extending.html which says: "Begin by creating a file spammodule.c. (Historically, if a module is called spam, the C file containing its implementation is called spammodule.c; ... )"
This minor change may help encourage this standard practice.

Arthur

@artgoldberg artgoldberg mannequin assigned docspython Apr 6, 2017
@artgoldberg artgoldberg mannequin added docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error labels Apr 6, 2017
@rhettinger
Copy link
Contributor

I'm not really sure that is a standard or even a best practice. I think some people do it and some don't.

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
@iritkatriel iritkatriel closed this as not planned Won't fix, can't repro, duplicate, stale Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

2 participants