[issue21777] Separate out documentation of binary sequence methods

[Nick Coghlan]

New submission from Nick Coghlan:

There are currently no dedicated docs for the bytes and bytearray methods - the relevant section just refers back to the str methods. This isn't sufficient, since the str methods cover of lot of stuff related to Unicode that isn't relevant to the binary sequence types, and it doesn't cleanly cover the differences either (like the fact that several methods accept integers).

I've started work on a patch that documents the binary APIs explicitly, although bytes and bytearray still share docs. The methods are grouped into three categories:

- work with arbitrary binary data
- assume ASCII compatibility by default, but can still be used with arbitrary binary data when given suitable arguments
- can only be used safely with data in an ASCII compatible format

I've worked through and updated the new entries for the first category, but the latter two categories are still just copy-and-paste from the str docs.

----------
assignee: ncoghlan
components: Documentation
files: separate_binary_sequence_docs.diff
keywords: patch
messages: 220711
nosy: ncoghlan
priority: normal
severity: normal
status: open
title: Separate out documentation of binary sequence methods
type: enhancement
versions: Python 3.4, Python 3.5
Added file: http://bugs.python.org/file35654/separate_binary_sequence_docs.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue21777>
_______________________________________