[issue16731] xxlimited/xxmodule docstrings ambiguous

[Berker Peksag]

Berker Peksag added the comment:

I think the difference between xxlimited and xxmodule is still a bit ambiguous. 
I would expect a mention of PEP 384 or a link to 
https://docs.python.org/3/c-api/stable.html to explain what Py_LIMITED_API 
really is.

+#ifndef Py_LIMITED_API
+# error "This file requires Py_LIMITED_API"
+#endif

I don't have a strong opinion about this, but I think the error message could 
be more informative (e.g. you must define a Py_LIMITED_API macro) Or we can 
improve https://docs.python.org/3/c-api/stable.html to give an example there.

--
nosy: +berker.peksag, serhiy.storchaka
stage:  -> patch review
type:  -> enhancement

___
Python tracker 

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

[issue16731] xxlimited/xxmodule docstrings ambiguous

[Camilla Montonen]

Camilla Montonen added the comment:

Changed xxlimited.c to xxmodule.c in the xxlimited.c docstring.

--
versions: +Python 3.5, Python 3.6 -Python 3.4
Added file: http://bugs.python.org/file41467/issue16731.patch

___
Python tracker 

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

[issue16731] xxlimited/xxmodule docstrings ambiguous

[Daniel Shahaf]

Daniel Shahaf added the comment:

I don't mind at all.  Go ahead :)

--

___
Python tracker 

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

[issue16731] xxlimited/xxmodule docstrings ambiguous

[Camilla Montonen]

Camilla Montonen added the comment:

Hi Daniel, 
just about to review this patch and noticed that the typo in xxlimited.c 
docstring is still there. Do you mind if I tweak your patch to fix this?

--
nosy: +Winterflower

___
Python tracker 

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

[issue16731] xxlimited/xxmodule docstrings ambiguous

[Andrew Svetlov]

Changes by Andrew Svetlov :


--
nosy: +asvetlov

___
Python tracker 

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

[issue16731] xxlimited/xxmodule docstrings ambiguous

[Éric Araujo]

Changes by Éric Araujo :


--
nosy: +eric.araujo, loewis

___
Python tracker 

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

[issue16731] xxlimited/xxmodule docstrings ambiguous

[Daniel Shahaf]

Daniel Shahaf added the comment:

Re the review, yes there is a typo in the comment: the comment in xxlimited.c 
should say "xxmodule.c" rather than "xxlimited.c".  (Got a traceback from the 
review app)

--

___
Python tracker 

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

[issue16731] xxlimited/xxmodule docstrings ambiguous

[Daniel Shahaf]

New submission from Daniel Shahaf:

Tweak the docstrings of xxmodule and xxlimited to clarify the difference 
between them (as derived from setup.py).  While at it also add a defensive 
coding guard to xxlimited to ensure it remains Py_LIMITED_API-safe.

--
assignee: docs@python
components: Documentation, Extension Modules
files: xxdocstrings.diff
keywords: patch
messages: 14
nosy: danielsh, docs@python
priority: normal
severity: normal
status: open
title: xxlimited/xxmodule docstrings ambiguous
versions: Python 3.4
Added file: http://bugs.python.org/file28367/xxdocstrings.diff

___
Python tracker 

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