Skip to content

Added alignable boolean series and its example to .loc docs. #35506

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 2 commits into from
Aug 2, 2020
Merged

Added alignable boolean series and its example to .loc docs. #35506

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4014a60
#31054 Added alignable boolean series and its example to `.loc` docs.
MJafarMashhadi Aug 1, 2020
6774b78
Applied comments to fix grammatical issues
MJafarMashhadi Aug 2, 2020
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
11 changes: 11 additions & 0 deletions pandas/core/indexing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ def loc(self) -> "_LocIndexer":

- A boolean array of the same length as the axis being sliced,
e.g. ``[True, False, True]``.
- An alignable boolean series. Index of the key will be aligned before
Copy link
Contributor

Choose a reason for hiding this comment

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

series should be capitalized

Copy link
Contributor

Choose a reason for hiding this comment

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

nit-pick: 'The index of the key'

masking.
- A ``callable`` function with one argument (the calling Series or
DataFrame) and that returns valid output for indexing (one of the above)

Expand All @@ -264,6 +266,8 @@ def loc(self) -> "_LocIndexer":
------
KeyError
If any items are not found.
IndexingError
If an indexed key is passed and its index is unalignable to the index.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit-pick: 'unalignable to the frame index'


See Also
--------
Expand Down Expand Up @@ -319,6 +323,13 @@ def loc(self) -> "_LocIndexer":
max_speed shield
sidewinder 7 8

Alignable boolean series:
Copy link
Contributor

Choose a reason for hiding this comment

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

series should be capitalized


>>> df.loc[pd.Series([False, True, False],
... index=['viper', 'sidewinder', 'cobra'])]
max_speed shield
sidewinder 7 8

Conditional that returns a boolean Series

>>> df.loc[df['shield'] > 6]
Expand Down