[issue16252] bytes and bytearray methods are undocumented

[Berker Peksag]

Berker Peksag added the comment:

Fixed in issue 21777.

--
nosy: +berker.peksag
resolution:  -> out of date
stage: needs patch -> resolved
status: open -> closed

___
Python tracker 

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

[issue16252] bytes and bytearray methods are undocumented

[Jesús Cea Avión]

Changes by Jesús Cea Avión :


--
nosy: +jcea

___
Python tracker 

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

[issue16252] bytes and bytearray methods are undocumented

[Chris Jerdonek]

Chris Jerdonek added the comment:

> I couldn't find any doc for bytes.join, etc.

One of the contributing factors to this is that bytes doesn't have its own 
class entry in the same way that, for example, list, dict, and memoryview have.

This creates a stumbling block for readers because they have to know to click 
on the "Bytes and Bytearray Operations" section as opposed to simply clicking 
on the type name as it is done for several other types.

With a class entry, locating where the methods are documented would be quicker 
and more intuitive.

--
nosy: +chris.jerdonek

___
Python tracker 

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

[issue16252] bytes and bytearray methods are undocumented

[Antoine Pitrou]

Antoine Pitrou added the comment:

For the record, in the SSL socket docs, I listed the supported methods 
explicitly (http://docs.python.org/dev/library/ssl.html#ssl-sockets). I think 
it makes things clearer for the reader.

--

___
Python tracker 

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

[issue16252] bytes and bytearray methods are undocumented

[Antoine Pitrou]

Antoine Pitrou added the comment:

Ah, right. I guess a hyperlink to those methods wouldn't hurt, though :)

--

___
Python tracker 

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

[issue16252] bytes and bytearray methods are undocumented

[Ezio Melotti]

Ezio Melotti added the comment:

http://docs.python.org/dev/library/stdtypes.html#bytes-and-bytearray-operations

"""
Due to the common use of ASCII text as the basis for binary protocols, bytes 
and bytearray objects provide almost all methods found on text strings, with 
the exceptions of:
"""

The additional methods are documented after that.

--
nosy: +ezio.melotti

___
Python tracker 

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

[issue16252] bytes and bytearray methods are undocumented

[Antoine Pitrou]

New submission from Antoine Pitrou:

Everything is in the title. I couldn't find any doc for bytes.join, etc. (while 
str methods are documented in library/stdtypes.html#string-methods).

--
assignee: docs@python
components: Documentation
messages: 173074
nosy: docs@python, pitrou
priority: normal
severity: normal
stage: needs patch
status: open
title: bytes and bytearray methods are undocumented
type: behavior
versions: Python 3.2, Python 3.3, Python 3.4

___
Python tracker 

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