Rooba
/
boltons
mirror of https://github.com/mahmoud/boltons.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

a couple docs formatting fixes for strutils

This commit is contained in:
Mahmoud Hashemi 2016-04-18 22:29:24 -07:00
parent 0bc6ddf58a
commit baf4619c6d
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
boltons/strutils.py
View File

@ -30,7 +30,8 @@ __all__ = ['camel2under', 'under2camel', 'slugify', 'split_punct_ws',
'unit_len', 'ordinalize', 'cardinalize', 'pluralize', 'singularize', 'unit_len', 'ordinalize', 'cardinalize', 'pluralize', 'singularize',
'asciify', 'is_ascii', 'is_uuid', 'html2text', 'strip_ansi', 'asciify', 'is_ascii', 'is_uuid', 'html2text', 'strip_ansi',
'bytes2human', 'find_hashtags', 'a10n', 'gunzip_bytes', 'bytes2human', 'find_hashtags', 'a10n', 'gunzip_bytes',
'iter_splitlines', 'indent', 'escape_shell_args', 'args2cmd', 'args2sh'] 'iter_splitlines', 'indent', 'escape_shell_args',
'args2cmd', 'args2sh']
_punct_ws_str = string.punctuation + string.whitespace _punct_ws_str = string.punctuation + string.whitespace
@ -670,7 +671,7 @@ def indent(text, margin, newline='\n', key=bool):
Args: Args:
text (str): The text to indent. text (str): The text to indent.
margin (str): The string to prepend to each line. margin (str): The string to prepend to each line.
newline (str): The newline used to rejoin the lines (default: \\n) newline (str): The newline used to rejoin the lines (default: ``\\n``)
key (callable): Called on each line to determine whether to key (callable): Called on each line to determine whether to
indent it. Default: :class:`bool`, to ensure that empty lines do indent it. Default: :class:`bool`, to ensure that empty lines do
not get whitespace added. not get whitespace added.