diff options
| author | Aurélien Bompard | 2015-12-16 11:29:27 +0100 |
|---|---|---|
| committer | Barry Warsaw | 2015-12-16 11:17:30 -0500 |
| commit | 1f6f1428fa01ea7d3499e3e1234fcd2241295675 (patch) | |
| tree | 2d944f06b2ed4641dcd73296d486db87d18a785b /src/mailman/model/docs | |
| parent | 564ee293884d794abb8a16995654c1be429db3ce (diff) | |
| download | mailman-1f6f1428fa01ea7d3499e3e1234fcd2241295675.tar.gz mailman-1f6f1428fa01ea7d3499e3e1234fcd2241295675.tar.zst mailman-1f6f1428fa01ea7d3499e3e1234fcd2241295675.zip | |
Implement suggestions from the review
Diffstat (limited to 'src/mailman/model/docs')
| -rw-r--r-- | src/mailman/model/docs/pending.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/src/mailman/model/docs/pending.rst b/src/mailman/model/docs/pending.rst index 4accf5f3f..9c21a09eb 100644 --- a/src/mailman/model/docs/pending.rst +++ b/src/mailman/model/docs/pending.rst @@ -43,8 +43,13 @@ There's exactly one entry in the pendings database now. 1 You can *confirm* the pending, which means returning the `IPendable` structure -(as a dictionary) from the database that matches the token. If the token -isn't in the database, None is returned. +(as a dictionary) from the database that matches the token. + +All `IPendable` classes have a `PEND_TYPE` attribute which must be a string. It +is used to identify and query pendables in the database, and will be returned +as the `type` key in the dictionary. + +If the token isn't in the database, None is returned. >>> pendable = pendingdb.confirm(b'missing') >>> print(pendable) |