diff options
| author | Arthur de Jong <arthur@arthurdejong.org> | 2017-09-10 23:24:08 +0200 |
|---|---|---|
| committer | Arthur de Jong <arthur@arthurdejong.org> | 2017-09-11 20:54:31 +0200 |
| commit | 1c276393d695f969f4600cb3adc49af71168d513 (patch) | |
| tree | bfe9e373d9212ef43f06de953f8d12bb3d413ef4 /stdnum/us/ssn.py | |
| parent | 2cc39ea459dcd712462113e12ceb5eda27de9ecb (diff) | |
Docstring improvements
Diffstat (limited to 'stdnum/us/ssn.py')
| -rw-r--r-- | stdnum/us/ssn.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/stdnum/us/ssn.py b/stdnum/us/ssn.py index d08bd9a..78d538e 100644 --- a/stdnum/us/ssn.py +++ b/stdnum/us/ssn.py @@ -81,8 +81,8 @@ def compact(number): def validate(number): - """Checks to see if the number provided is a valid SSN. This checks - the length, groups and formatting if it is present.""" + """Check if the number is a valid SSN. This checks the length, groups and + formatting if it is present.""" match = _ssn_re.search(clean(number, '').strip()) if not match: raise InvalidFormat() @@ -101,8 +101,7 @@ def validate(number): def is_valid(number): - """Checks to see if the number provided is a valid SSN. This checks - the length, groups and formatting if it is present.""" + """Check if the number is a valid SSN.""" try: return bool(validate(number)) except ValidationError: @@ -110,7 +109,7 @@ def is_valid(number): def format(number): - """Reformat the passed number to the standard format.""" + """Reformat the number to the standard presentation format.""" if len(number) == 9: number = number[:3] + '-' + number[3:5] + '-' + number[5:] return number |