Skip to content

Commit 8ad9b47

Browse files
committed
add short usage example to readme
1 parent e200673 commit 8ad9b47

1 file changed

Lines changed: 15 additions & 16 deletions

File tree

README.rst

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,22 @@ approach. It's not perfect, but it gets you pretty far.
2121
* o.suffix
2222
* o.nickname
2323

24-
Supports 3 different comma placement variations in the input string.
24+
**Usage Example**
25+
26+
::
27+
28+
>>> from nameparser import HumanName
29+
>>> name = HumanName("Dr. Juan Q. Xavier de la Vega III (Doc Vega)")
30+
>>> name
31+
<HumanName : [
32+
title: 'Dr.'
33+
first: 'Juan'
34+
middle: 'Q. Xavier'
35+
last: 'de la Vega'
36+
suffix: 'III'
37+
nickname: 'Doc Vega'
38+
]>
2539

26-
* Title Firstname "Nickname" Middle Middle Lastname Suffix
27-
* Lastname, Title Firstname (Nickname) Middle Middle[,] Suffix [, Suffix]
28-
* Title Firstname M Lastname, Suffix [, Suffix]
29-
30-
**Examples of supported formats**
31-
32-
* Doe-Ray, Col. Jonathan "John" A. Jérôme III
33-
* Dr. Juan Q. Xavier de la Vega II
34-
* Juan Q. Xavier Velasquez y Garcia, Jr.
35-
36-
When there is ambiguity that cannot be resolved by a rule-based approach,
37-
HumanName prefers to handle the most common cases correctly. For example,
38-
"Dean" is not parsed as title because it is more common as a first name.
39-
(You can customize this behavior though, see `Customizing the Parser with
40-
Your Own Constants`_)
4140

4241
Unit Tests
4342
------------

0 commit comments

Comments
 (0)