lack of PyExc_BufferError doc

[xwhhsprings]

BPO	19225
Nosy	@berkerpeksag, @vadmium, @serhiy-storchaka, @cocoatomo
PRs	bpo-19225: Lack of c api exceptions doc #881 [2.7] bpo-19225: Lack of c api exceptions doc #964 [3.5] bpo-19225: Lack of c api exceptions doc #965 [3.6] bpo-19225: Lack of c api exceptions doc #966 [3.6]: bpo-19225: Add a table of warning names and missed exception n… #969 [3.5]: bpo-19225: Add a table of warning names and missed exception n… #970 bpo-19225: Remove duplicated description for standard warning categories #1068 [2.7] bpo-19225: Remove duplicated description for standard warning categories #1199 [3.5] bpo-19225: Remove duplicated description for standard warning categories #1200 [3.6] bpo-19225: Remove duplicated description for standard warning categories #1201
Files	doc_exceptions.patch doc_exceptions_v1.patch

^{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 2017-04-20.03:58:48.529>
created_at = <Date 2013-10-11.10:02:57.900>
labels = ['easy', 'type-feature', '3.7', 'docs']
title = 'lack of PyExc_BufferError doc'
updated_at = <Date 2017-04-20.03:58:48.527>
user = 'https://bugs.python.org/xwhhsprings'

bugs.python.org fields:

activity = <Date 2017-04-20.03:58:48.527>
actor = 'berker.peksag'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-04-20.03:58:48.529>
closer = 'berker.peksag'
components = ['Documentation']
creation = <Date 2013-10-11.10:02:57.900>
creator = 'xwhhsprings'
dependencies = []
files = ['41688', '41727']
hgrepos = []
issue_num = 19225
keywords = ['patch', 'easy']
message_count = 20.0
messages = ['199458', '199460', '258770', '258798', '258987', '259023', '289196', '290763', '291030', '291031', '291047', '291228', '291229', '291318', '291336', '291696', '291937', '291938', '291939', '291940']
nosy_count = 7.0
nosy_names = ['docs@python', 'berker.peksag', 'martin.panter', 'serhiy.storchaka', 'xwhhsprings', 'cocoatomo', 'beng94']
pr_nums = ['881', '964', '965', '966', '969', '970', '1068', '1199', '1200', '1201']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue19225'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7']

[xwhhsprings]

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.

[xwhhsprings]

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...?

[beng94]

Let me try to solve this issue. Will be back in 4 days.

[beng94]

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.

[vadmium]

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 bpo-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 :)

[beng94]

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.

[cocoatomo]

This issue seems pending.

beng94

Would you create a pull request?

[cocoatomo]

I will create a pull request based on the patch created by beng94.
In addition, I will have its contents up-to-date.