[New-bugs-announce] [issue8973] Inconsistent docstrings in struct module

Alexander Belopolsky report at bugs.python.org
Fri Jun 11 17:32:37 CEST 2010


New submission from Alexander Belopolsky <belopolsky at users.sourceforge.net>:

Module level pack, unpack etc. methods have similar functionality with Struct instance methods, but docs are different.  The immediate issue is the lack of signature in the module level methods' docstrings.


$ ./python.exe -m pydoc struct.Struct.pack
Help on method_descriptor in struct.Struct:

struct.Struct.pack = pack(...)
    S.pack(v1, v2, ...) -> bytes
    
    Return a bytes containing values v1, v2, ... packed according to this
    Struct's format. See struct.__doc__ for more on format strings.

and

$ ./python.exe -m pydoc struct.pack
Help on built-in function pack in struct:

struct.pack = pack(...)
    Return bytes containing values v1, v2, ... packed according to fmt.

----------
components: Extension Modules
messages: 107556
nosy: belopolsky, mark.dickinson
priority: normal
severity: normal
status: open
title: Inconsistent docstrings in struct module
type: behavior
versions: Python 3.2

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


More information about the New-bugs-announce mailing list