Skip to content

Commit a7cb103

Browse files
author
araraonline
committed
Add missing periods in docstrings
1 parent e624495 commit a7cb103

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

pandas/core/indexes/api.py

+17-17
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,20 @@ def _get_objs_combined_axis(objs, intersect=False, axis=0, sort=True):
4747
"""
4848
Extract combined index: return intersection or union (depending on the
4949
value of "intersect") of indexes on given axis, or None if all objects
50-
lack indexes (e.g. they are numpy arrays)
50+
lack indexes (e.g. they are numpy arrays).
5151
5252
Parameters
5353
----------
5454
objs : list of objects
5555
Each object will only be considered if it has a _get_axis
56-
attribute
56+
attribute.
5757
intersect : boolean, default False
5858
If True, calculate the intersection between indexes. Otherwise,
59-
calculate the union
59+
calculate the union.
6060
axis : {0 or 'index', 1 or 'outer'}, default 0
61-
The axis to extract indexes from
61+
The axis to extract indexes from.
6262
sort : boolean, default True
63-
Whether the result index should come out sorted or not
63+
Whether the result index should come out sorted or not.
6464
6565
Returns
6666
-------
@@ -74,17 +74,17 @@ def _get_objs_combined_axis(objs, intersect=False, axis=0, sort=True):
7474

7575
def _get_combined_index(indexes, intersect=False, sort=False):
7676
"""
77-
Return the union or intersection of indexes
77+
Return the union or intersection of indexes.
7878
7979
Parameters
8080
----------
8181
indexes : a list of Index or list objects
82-
When intersect=True, do not accept list of lists
82+
When intersect=True, do not accept list of lists.
8383
intersect : boolean, default False
8484
If True, calculate the intersection between indexes. Otherwise,
85-
calculate the union
85+
calculate the union.
8686
sort : boolean, default False
87-
Whether the result index should come out sorted or not
87+
Whether the result index should come out sorted or not.
8888
8989
Returns
9090
-------
@@ -115,15 +115,15 @@ def _get_combined_index(indexes, intersect=False, sort=False):
115115

116116
def _union_indexes(indexes, sort=True):
117117
"""
118-
Return the union of indexes
118+
Return the union of indexes.
119119
120120
The behavior of sort and names is not consistent.
121121
122122
Parameters
123123
----------
124124
indexes : a list of Index or list objects
125125
sort : boolean, default True
126-
Whether the result index should come out sorted or not
126+
Whether the result index should come out sorted or not.
127127
128128
Returns
129129
-------
@@ -141,7 +141,7 @@ def _union_indexes(indexes, sort=True):
141141

142142
def _unique_indices(inds):
143143
"""
144-
Convert indexes to lists and concatenate them, removing duplicates
144+
Convert indexes to lists and concatenate them, removing duplicates.
145145
146146
The final dtype is inferred.
147147
@@ -192,7 +192,7 @@ def conv(i):
192192

193193
def _sanitize_and_check(indexes):
194194
"""
195-
Verify the type of indexes and convert lists to Index
195+
Verify the type of indexes and convert lists to Index.
196196
197197
Cases:
198198
@@ -230,7 +230,7 @@ def _sanitize_and_check(indexes):
230230

231231
def _get_consensus_names(indexes):
232232
"""
233-
Give a consensus 'names' to indexes
233+
Give a consensus 'names' to indexes,
234234
235235
If there's exactly one non-empty 'names', return this,
236236
otherwise, return empty.
@@ -242,7 +242,7 @@ def _get_consensus_names(indexes):
242242
Returns
243243
-------
244244
list
245-
A list representing the consensus 'names' found
245+
A list representing the consensus 'names' found.
246246
"""
247247

248248
# find the non-none names, need to tupleify to make
@@ -256,7 +256,7 @@ def _get_consensus_names(indexes):
256256

257257
def _all_indexes_same(indexes):
258258
"""
259-
Determine if all indexes contain the same elements
259+
Determine if all indexes contain the same elements.
260260
261261
Parameters
262262
----------
@@ -265,7 +265,7 @@ def _all_indexes_same(indexes):
265265
Returns
266266
-------
267267
boolean
268-
True if all indexes contain the same elements, False otherwise
268+
True if all indexes contain the same elements, False otherwise.
269269
"""
270270
first = indexes[0]
271271
for index in indexes[1:]:

0 commit comments

Comments
 (0)