Skip to content

DOC: Updating str_pad docstring #22570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Sep 25, 2018
Merged

DOC: Updating str_pad docstring #22570

Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
52bc395
Cleaned up docstring for str_pad and corrected documentation to match…
JesperDramsch Sep 1, 2018
5d5b192
PEP8-ing
JesperDramsch Sep 1, 2018
28ec7b0
PEP8-ing example
JesperDramsch Sep 1, 2018
8337a53
Explicit names and some fixes
JesperDramsch Sep 1, 2018
0224b12
Shorten first line
JesperDramsch Sep 2, 2018
763f3c3
Add periods
JesperDramsch Sep 2, 2018
50940c8
Examples fixed, See Also added
JesperDramsch Sep 3, 2018
c473a4f
Whitespace be gone
JesperDramsch Sep 3, 2018
6f6853e
Period
JesperDramsch Sep 3, 2018
7456656
Sorting and Validation
JesperDramsch Sep 21, 2018
f2d221d
Add See also info
JesperDramsch Sep 21, 2018
0640204
Delete obsolete example
JesperDramsch Sep 22, 2018
c785311
small fixup
jorisvandenbossche Sep 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions pandas/core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1314,21 +1314,42 @@ def str_index(arr, sub, start=0, end=None, side='left'):

def str_pad(arr, width, side='left', fillchar=' '):
"""
Pad strings in the Series/Index with an additional character to
specified side.
Pad strings in the Series/Index with additional characters on
specified side to fill up to specified width.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think in this case we could have a extended summary, providing a bit more information on what pad means, and when it can be useful.

Parameters
----------
width : int
Minimum width of resulting string; additional characters will be filled
with spaces
with character defined in fillchar
side : {'left', 'right', 'both'}, default 'left'
fillchar : str
Side from which to fill resulting string
fillchar : str, default ' '
Additional character for filling, default is whitespace

Returns
-------
padded : Series/Index of objects
Series or Index of object
Returns Series or Index with minimum number of char in object

Examples
--------
>>> s = pd.Series(["panda", "fox"])
>>> s
0 panda
1 fox

>>> s.str.pad(width=10)
0 panda
1 fox

>>> s.str.pad(width=10, side='right', fillchar='-')
0 panda-----
1 fox-------

>>> s.str.pad(width=10, side='both', fillchar='-')
0 --panda---
1 ---fox----
"""

if not isinstance(fillchar, compat.string_types):
Expand Down