Skip to content

Commit

Permalink
DOC: Remove incorrect periods at the end of parameter types (pandas-d…
Browse files Browse the repository at this point in the history
  • Loading branch information
meiermark authored and Pingviinituutti committed Feb 28, 2019
1 parent ab6b5f0 commit 8d93af8
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 20 deletions.
22 changes: 11 additions & 11 deletions pandas/core/dtypes/inference.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ def is_string_like(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Examples
--------
Expand Down Expand Up @@ -127,7 +127,7 @@ def is_iterator(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand Down Expand Up @@ -172,7 +172,7 @@ def is_file_like(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand Down Expand Up @@ -203,7 +203,7 @@ def is_re(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand All @@ -227,7 +227,7 @@ def is_re_compilable(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand Down Expand Up @@ -261,7 +261,7 @@ def is_list_like(obj, allow_sets=True):
Parameters
----------
obj : The object to check.
obj : The object to check
allow_sets : boolean, default True
If this parameter is False, sets will not be considered list-like
Expand Down Expand Up @@ -310,7 +310,7 @@ def is_array_like(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand Down Expand Up @@ -343,7 +343,7 @@ def is_nested_list_like(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand Down Expand Up @@ -384,7 +384,7 @@ def is_dict_like(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand All @@ -408,7 +408,7 @@ def is_named_tuple(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand Down Expand Up @@ -468,7 +468,7 @@ def is_sequence(obj):
Parameters
----------
obj : The object to check.
obj : The object to check
Returns
-------
Expand Down
4 changes: 2 additions & 2 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -5248,11 +5248,11 @@ def astype(self, dtype, copy=True, errors='raise', **kwargs):
the same type. Alternatively, use {col: dtype, ...}, where col is a
column label and dtype is a numpy.dtype or Python type to cast one
or more of the DataFrame's columns to column-specific types.
copy : bool, default True.
copy : bool, default True
Return a copy when ``copy=True`` (be very careful setting
``copy=False`` as changes to values then may propagate to other
pandas objects).
errors : {'raise', 'ignore'}, default 'raise'.
errors : {'raise', 'ignore'}, default 'raise'
Control raising of exceptions on invalid data for provided dtype.
- ``raise`` : allow exceptions to be raised
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexes/datetimes.py
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ def to_series(self, keep_tz=False, index=None, name=None):
Parameters
----------
keep_tz : optional, defaults False.
keep_tz : optional, defaults False
return the data keeping the timezone.
If keep_tz is True:
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexes/multi.py
Original file line number Diff line number Diff line change
Expand Up @@ -1885,7 +1885,7 @@ def sortlevel(self, level=0, ascending=True, sort_remaining=True):
ascending : boolean, default True
False to sort in descending order
Can also be a list to specify a directed ordering
sort_remaining : sort by the remaining levels after level.
sort_remaining : sort by the remaining levels after level
Returns
-------
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/indexes/range.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class RangeIndex(Int64Index):
Parameters
----------
start : int (default: 0), or other RangeIndex instance.
start : int (default: 0), or other RangeIndex instance
If int and "stop" is not given, interpreted as "stop" instead.
stop : int (default: 0)
step : int (default: 1)
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/series.py
Original file line number Diff line number Diff line change
Expand Up @@ -3025,7 +3025,7 @@ def reorder_levels(self, order):
Parameters
----------
order : list of int representing new level order.
order : list of int representing new level order
(reference level by number or key)
Returns
Expand Down
4 changes: 2 additions & 2 deletions pandas/core/strings.py
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ def str_match(arr, pat, case=True, flags=0, na=np.nan):
If True, case sensitive
flags : int, default 0 (no flags)
re module flags, e.g. re.IGNORECASE
na : default NaN, fill value for missing values.
na : default NaN, fill value for missing values
Returns
-------
Expand Down Expand Up @@ -2665,7 +2665,7 @@ def encode(self, encoding, errors="strict"):
Parameters
----------
to_strip : str or None, default None.
to_strip : str or None, default None
Specifying the set of characters to be removed.
All combinations of this set of characters will be stripped.
If None then whitespaces are removed.
Expand Down
2 changes: 1 addition & 1 deletion pandas/io/clipboards.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def read_clipboard(sep=r'\s+', **kwargs): # pragma: no cover
Parameters
----------
sep : str, default '\s+'.
sep : str, default '\s+'
A string or regex delimiter. The default of '\s+' denotes
one or more whitespace characters.
Expand Down

0 comments on commit 8d93af8

Please sign in to comment.