Python-Crypto

Hash objects will become undocumented from v2.7

Bug #1179255 reported by Legrandin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Python-Crypto
Confirmed
Undecided
Unassigned

Bug Description

In the current version (2.6), the hash objects (e.g. as returned by Crypto.Hash.SHA256.new) have got a minimal level of epydoc-generated HTML documentation. For instance:

https://www.dlitz.net/software/pycrypto/api/current/Crypto.Hash.SHA256.SHA256Hash-class.html

However, with the recent changes that part of documentation has disappeared and objects are now undocumented.
What has remained is simply the "new()" function of the hash module.
In order to know what an instance of the object does and which methods it has, one has to dig into the C source code.

Legrandin (gooksankoo)
summary: - Hash objects will become undocumented
+ Hash objects will become undocumented from v2.7
Revision history for this message
Darsey Litzenberger (dlitz) wrote :

I think this should take care of this issue:

https://github.com/dlitz/pycrypto/commit/63bc0fb0aa463a70a0d115fad21219b896683c8d

Changed in pycrypto:
status: New → Fix Committed
Revision history for this message
Legrandin (gooksankoo) wrote :

MD5 and SHA1 objects are still undocumented.

SHA module should have an indication that SHA1 should be be used instead.
Same for RIPEMD.

For all hash objects, the documentation of digest() seems to have a stray sentence ("characters, including null bytes.").

Revision history for this message
Darsey Litzenberger (dlitz) wrote :

Ok, thanks.

Changed in pycrypto:
status: Fix Committed → Confirmed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.