diff options
| author | Arthur de Jong <arthur@arthurdejong.org> | 2012-02-26 12:10:38 +0100 |
|---|---|---|
| committer | Arthur de Jong <arthur@arthurdejong.org> | 2012-02-26 12:10:38 +0100 |
| commit | 902a6569bf90aa37a185a2e099b913b39b6db3f7 (patch) | |
| tree | c9894909466a10c906d851902319d152ce6048db /stdnum/luhn.py | |
| parent | 907e41082fe4d05556d402dc30376fce9f32d344 (diff) | |
ensure that the module docstrings are in a somewhat more usable format
git-svn-id: http://arthurdejong.org/svn/python-stdnum/python-stdnum@165 9dea7c4f-944c-4273-ac1a-574ede026edc
Diffstat (limited to 'stdnum/luhn.py')
| -rw-r--r-- | stdnum/luhn.py | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/stdnum/luhn.py b/stdnum/luhn.py index 388305b..a6391ae 100644 --- a/stdnum/luhn.py +++ b/stdnum/luhn.py @@ -17,12 +17,14 @@ # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA # 02110-1301 USA -"""Module for calculation and verifying the checksum of a number -using the Luhn algorithm. +"""The Luhn and Luhn mod N algorithms. -Validation can be done with is_valid() which validates that the -calculated checksum is 0. A valid number can be made by calculating -the check digit and appending it. +The Luhn algorithm to detect most accidental errors in various +identification numbers. + +Validation can be done with is_valid() which validates that the calculated +checksum is 0. A valid number can be made by calculating the check digit +and appending it. >>> is_valid('7894') False @@ -40,7 +42,6 @@ The default alphabet is '0123456789'. False >>> checksum('1234', alphabet='0123456789abcdef') 14 - """ |