classification
Title: lack of PyExc_BufferError doc
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.7, Python 3.6, Python 3.5, Python 2.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: beng94, cocoatomo, docs@python, martin.panter, xwhhsprings
Priority: normal Keywords: easy, patch

Created on 2013-10-11 10:02 by xwhhsprings, last changed 2017-03-29 01:26 by cocoatomo.

Files
File name Uploaded Description Edit
doc_exceptions.patch beng94, 2016-01-22 13:04 review
doc_exceptions_v1.patch beng94, 2016-01-27 15:06 review
Pull Requests
URL Status Linked Edit
PR 881 open cocoatomo, 2017-03-29 01:26
Messages (8)
msg199458 - (view) Author: hiroaki itoh (xwhhsprings) Date: 2013-10-11 10:02
http://docs.python.org/2.7/c-api/exceptions.html#standard-exceptions

Python2.7 (at least 2.7.5) has PyExc_BufferError, but the document does not tell it.
msg199460 - (view) Author: hiroaki itoh (xwhhsprings) Date: 2013-10-11 10:19
also:

* GeneratorExit
* StopIteration
* VMSError (#ifdef __VMS)
* UnboundLocalError
* IndentationError
* TabError
* UnicodeError
* UnicodeDecodeError
* UnicodeEncodeError
* UnicodeTranslateError

* Warning;
* UserWarning;
* DeprecationWarning;
* PendingDeprecationWarning;
* SyntaxWarning;
* RuntimeWarning;
* FutureWarning;
* ImportWarning;
* UnicodeWarning;
* BytesWarning;

Or, erase `For completeness, here are all the variables' statement...?
msg258770 - (view) Author: Tamás Bence Gedai (beng94) * Date: 2016-01-21 21:59
Let me try to solve this issue. Will be back in 4 days.
msg258798 - (view) Author: Tamás Bence Gedai (beng94) * Date: 2016-01-22 13:04
I've created a new table for warnings and added the missing exceptions to the exceptions table.

I did not find a link for VMSError, but I added it to the table.

Note that the exceptions table is not absolutely in alphabetical order, I can fix it as well, if it's needed.
msg258987 - (view) Author: Martin Panter (martin.panter) * (Python committer) Date: 2016-01-27 01:45
General approach looks good. I left some review comments.

VMSError: I think this is Python 2 only, where it seems to be in a similar situation to WindowsError. According to Issue 16136 it was removed in Python 3.4. But it looks like your patch is against Python 3.

If you want to fix the alphabetical order, I think that is okay to do in the same patch. Otherwise, the current state is okay, but please put your BufferError in the right place :)
msg259023 - (view) Author: Tamás Bence Gedai (beng94) * Date: 2016-01-27 15:06
Thanks Martin for the review!

I tried to fix the problems, I hope now it'll be good.

Changes:
- fixed uppercase 'B'
- removed VMSError
- moved notes after versionchanged
- added two indices for the different tables
* put BufferError in it's place

I didn't fix the alphabetical order to keep the patch clean. If you find this patch good, I'll fix that as well if it's needed.
msg289196 - (view) Author: Kinebuchi Tomohiko (cocoatomo) * Date: 2017-03-08 02:32
This issue seems pending.

> beng94

Would you create a pull request?
msg290763 - (view) Author: Kinebuchi Tomohiko (cocoatomo) * Date: 2017-03-29 01:20
I will create a pull request based on the patch created by beng94.
In addition, I will have its contents up-to-date.
History
Date User Action Args
2017-03-29 01:26:19cocoatomosetpull_requests: + pull_request783
2017-03-29 01:20:11cocoatomosetmessages: + msg290763
versions: + Python 3.7
2017-03-08 02:32:22cocoatomosetnosy: + cocoatomo
messages: + msg289196
2016-01-27 15:06:17beng94setfiles: + doc_exceptions_v1.patch

messages: + msg259023
2016-01-27 01:45:08martin.pantersetnosy: + martin.panter

messages: + msg258987
stage: needs patch -> patch review
2016-01-22 13:04:43beng94setfiles: + doc_exceptions.patch
keywords: + patch
messages: + msg258798
2016-01-21 21:59:09beng94setnosy: + beng94
messages: + msg258770
2016-01-20 07:27:02berker.peksagsetkeywords: + easy
stage: needs patch
type: behavior -> enhancement
versions: + Python 3.5, Python 3.6
2013-10-11 10:19:23xwhhspringssetmessages: + msg199460
2013-10-11 10:02:57xwhhspringscreate