minor documentation fix for '__import__'

[oldk1331]

BPO	32674
Nosy	@matrixise, @Mariatta, @oldk1331
PRs	bpo-32674: minor documentation fix for '__import__' #5339 [3.7] bpo-32674: Improve the docstring for __import__ (GH-5339) #5488 [3.6] bpo-32674: Improve the docstring for __import__ (GH-5339) #5489 [2.7] bpo-32674: Improve the docstring for __import__ (GH-5339) #5494

^{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 = <Date 2018-02-02.16:25:38.848>
created_at = <Date 2018-01-26.06:41:42.216>
labels = ['3.7', '3.8', 'docs']
title = "minor documentation fix for '__import__'"
updated_at = <Date 2018-02-02.16:25:38.846>
user = 'https://github.com/oldk1331'

bugs.python.org fields:

activity = <Date 2018-02-02.16:25:38.846>
actor = 'Mariatta'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-02-02.16:25:38.848>
closer = 'Mariatta'
components = ['Documentation']
creation = <Date 2018-01-26.06:41:42.216>
creator = 'Qian Yun'
dependencies = []
files = []
hgrepos = []
issue_num = 32674
keywords = ['patch', 'needs review']
message_count = 8.0
messages = ['310741', '310742', '310743', '310745', '311474', '311489', '311503', '311504']
nosy_count = 4.0
nosy_names = ['docs@python', 'matrixise', 'Mariatta', 'Qian Yun']
pr_nums = ['5339', '5488', '5489', '5494']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue32674'
versions = ['Python 2.7', 'Python 3.6', 'Python 3.7', 'Python 3.8']

[oldk1331]

This is a minor documentation for builtin function '__import__'.

[matrixise]

minor documentation?

I don't understand, the documentation of __import__ is well done, could you explain ?

https://docs.python.org/3/library/functions.html#__import__

thank you

[oldk1331]

Sorry, a typo, it's "minor documentation fix".

See #5339

diff --git a/Python/bltinmodule.c b/Python/bltinmodule.c
index d8971bef2a..80b4f9447c 100644
--- a/Python/bltinmodule.c
+++ b/Python/bltinmodule.c
@@ -317,7 +317,7 @@ PyDoc_STRVAR(import_doc,
 "__import__(name, globals=None, locals=None, fromlist=(), level=0) -> module\n\
 \n\
 Import a module. Because this function is meant for use by the Python\n\
-interpreter and not for general use it is better to use\n\
+interpreter and not for general use, it is better to use\n\
 importlib.import_module() to programmatically import a module.\n\
 \n\
 The globals argument is only used to determine the context;\n\
@@ -326,8 +326,8 @@ should be a list of names to emulate ``from name import ...'', or an\n\
 empty list to emulate ``import name''.\n\
 When importing a module from a package, note that __import__('A.B', ...)\n\
 returns package A when fromlist is empty, but its submodule B when\n\
-fromlist is not empty.  Level is used to determine whether to perform \n\
-absolute or relative imports. 0 is absolute while a positive number\n\
+fromlist is not empty.  The level argument is used to determine whether to\n\
+perform absolute or relative imports, 0 is absolute while a positive number\n\
 is the number of parent directories to search relative to the current module.");

[matrixise]

Don't worry, but in fact, I did not understand because when you post
your issue, there was no associated PR.

Now, I do understand.

Thank you

[Mariatta]

New changeset 461d225 by Mariatta (oldk) in branch 'master':
bpo-32674: Improve the docstring for __import__ (GH-5339)
461d225

[Mariatta]

New changeset f61951b by Mariatta (Miss Islington (bot)) in branch '3.6':
bpo-32674: Improve the docstring for __import__ (GH-5339) (GH-5489)
f61951b

[Mariatta]

New changeset 9b7b3a6 by Mariatta in branch '2.7':
bpo-32674: Improve the docstring for __import__ (GH-5339) (GH-5494)
9b7b3a6

[Mariatta]

Thanks!