Skip to content

Commit 26717c2

Browse files
committed
README.md update
1 parent 65fea97 commit 26717c2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ pip install tssplit
1414
### Syntax
1515

1616
```Python3
17-
def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim='', remark='#'):
17+
def tssplit(s:str, quote:str='"\'', quote_keep:bool=False, delimiter:str=':;,', escape:str='/^', trim:str='',
18+
remark:str='#') -> list[str]:
19+
1820
"""Split a string by delimiters with quotes and escaped characters, optionally trimming results
1921
2022
:param s: A string to split into chunks
@@ -31,7 +33,7 @@ def tssplit(s, quote='"\'', quote_keep=False, delimiter=':;,', escape='/^', trim
3133
### Example
3234

3335
```Python3
34-
from tssplit import tssplit
36+
import tssplit
3537

3638
tssplit('--:--;--,--"--/--"--\'--:--\'--/"--^--',
3739
quote='"\'', delimiter=':;,', escape='/^', trim='')

0 commit comments

Comments
 (0)