Skip to content

Commit ec6d57e

Browse files
committed
Change documentation
1 parent 37a1b32 commit ec6d57e

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ Wrapper modified by Olaf Conradi to use the hashlib interface.
1010

1111
Usage
1212
-----
13+
14+
This is the same interface as provided by the other digest algorithms in
15+
Python's hashlib.
1316

1417
import whirlpool
1518

@@ -22,6 +25,8 @@ Usage
2225
Deprecated usage
2326
----------------
2427

28+
For backward compatibility the old interface remains available.
29+
2530
import whirlpool
2631

2732
hashed_string = whirlpool.hash("My String")

main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,6 @@ Return a new whirlpool object. If arg is present, the method call update(arg)\n\
268268
is made.");
269269

270270

271-
// TODO Mark deprecated
272271
static PyObject *
273272
whirlpool_hash(PyObject *self, PyObject *args) {
274273
struct NESSIEstruct w;
@@ -288,7 +287,8 @@ whirlpool_hash(PyObject *self, PyObject *args) {
288287
}
289288

290289
PyDoc_STRVAR(hash_doc,
291-
"Returns a hash of argument using the whirlpool algorithm.");
290+
"Returns a hash of argument using the whirlpool algorithm.\n\
291+
This function is deprecated. Please use new() and hexdigest().");
292292

293293

294294
/* List of functions exported by this module */

0 commit comments

Comments
 (0)