[issue27740] Fix doc of Py_CompileStringExFlags

[Berker Peksag]

Changes by Berker Peksag :


--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed
versions: +Python 3.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Roundup Robot]

Roundup Robot added the comment:

New changeset ee76e84f115f by Berker Peksag in branch '3.5':
Issue #27740: Fix typo in Py_CompileStringExFlags
https://hg.python.org/cpython/rev/ee76e84f115f

New changeset 2ee939b314a2 by Berker Peksag in branch '3.6':
Issue #27740: Merge from 3.5
https://hg.python.org/cpython/rev/2ee939b314a2

New changeset a0b13ea75849 by Berker Peksag in branch 'default':
Issue #27740: Merge from 3.6
https://hg.python.org/cpython/rev/a0b13ea75849

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Xiang Zhang]

Xiang Zhang added the comment:

I am not a native speaker so I decide not to trap in the minor part. Could you 
just fix the first point if there is no doubt? I'm okay with the second part 
staying as now.

--
Added file: https://bugs.python.org/file44242/issue27740.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Xiang Zhang]

Xiang Zhang added the comment:

> filename is going to be decoded inside of Py_CompileStringExFlags

Actually all I want to express is this, *filename* will be decoded inside. But 
now the wording looks to me is that *filename* is already a decoded string when 
passed. I don't want to document anything about PyUnicode_EncodeFSDefault. I 
should remove (:func:`os.fsdecode`). How do you think? I'm Okay if you think 
the current wording is correct.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Berker Peksag]

Berker Peksag added the comment:

I don't understand the second part of the patch.

*filename* is a filesystem encoding (:func:`os.fsdecode`) encoded string 
[...]

Do you want to document that filename should be encoded by using 
PyUnicode_EncodeFSDefault *before* passing it to Py_CompileStringExFlags (you 
will probably need to wrap it with something like PyBytes_AsString too)? If so, 
I think the os.fsdecode() part needs to be changed to os.fsencode().

I think the current wording is saying that filename is going to be decoded 
inside of Py_CompileStringExFlags (which is also correct.)

--
nosy: +berker.peksag, haypo
stage:  -> patch review
versions: +Python 3.5

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Xiang Zhang]

Xiang Zhang added the comment:

Ping.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Xiang Zhang]

Changes by Xiang Zhang :


Added file: http://bugs.python.org/file44085/Py_CompileStringExFlags_doc.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Xiang Zhang]

Changes by Xiang Zhang :


Removed file: http://bugs.python.org/file44078/Py_CompileStringExFlags_doc.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27740] Fix doc of Py_CompileStringExFlags

[Xiang Zhang]

New submission from Xiang Zhang:

I think the doc of Py_CompileStringExFlags has two flaws:

1. Py_CompileStringExFlags should be replaced by Py_CompileStringObject from 
the context. Py_CompileStringExFlags in the context is meaningless.

2. *filename* is a byte string that should be decoded but not decoded from. It 
is ... = decode(filename) but not filename = decode(...).

--
assignee: docs@python
components: Documentation
files: Py_CompileStringExFlags_doc.patch
keywords: patch
messages: 272468
nosy: docs@python, xiang.zhang
priority: normal
severity: normal
status: open
title: Fix doc of Py_CompileStringExFlags
type: behavior
versions: Python 3.6
Added file: http://bugs.python.org/file44078/Py_CompileStringExFlags_doc.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com