Skip to content

DOC: Added sentence to show that unmatched values return -1. #43738

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.

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 15 commits into from
Nov 6, 2021

Conversation

DhruvBShetty
Copy link
Contributor

@DhruvBShetty DhruvBShetty commented Sep 25, 2021

In [1]: python make.py --single pandas.Index.get_indexer
Out [1]:image

In [2]: pre-commit run --files pandas/core/indexes/base.py
Out [2] : image

@pep8speaks
Copy link

pep8speaks commented Sep 25, 2021

Hello @DhruvBShetty! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2021-11-01 12:05:03 UTC

@debnathshoham debnathshoham added Docs Index Related to the Index class or subclasses labels Sep 25, 2021
@DhruvBShetty DhruvBShetty changed the title GH38482: Added sentence to show that unmatched values return -1. DOC: Added sentence to show that unmatched values return -1. Sep 25, 2021
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Thanks @DhruvBShetty

@debnathshoham debnathshoham added this to the 1.4 milestone Sep 25, 2021
@@ -3484,6 +3484,9 @@ def get_loc(self, key, method=None, tolerance=None):
indexer should be then used as an input to ndarray.take to align the
current data to the new index.

Returns -1 for unmatched values, for further explanation see the example
Copy link
Contributor

Choose a reason for hiding this comment

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

move to the Notes section

@github-actions
Copy link
Contributor

This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this.

@github-actions github-actions bot added the Stale label Oct 30, 2021
@MarcoGorelli
Copy link
Member

Hi @DhruvBShetty can you address the comment please

@DhruvBShetty
Copy link
Contributor Author

This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this.

Interested in finishing this.

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

please check the pandas docstring guide for how to write the "notes" section

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Can you run the validating docstrings script for this function?

@DhruvBShetty
Copy link
Contributor Author

Can you run the validating docstrings script for this function?

Done, It's the first error
image

After which it's this
image

Left a line between %(raises_section)s and notes accidentally.
image

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Nice, thanks!

@mroeschke mroeschke merged commit 057c6f8 into pandas-dev:master Nov 6, 2021
@mroeschke
Copy link
Member

Thanks @DhruvBShetty

@DhruvBShetty DhruvBShetty deleted the doc-feature branch January 14, 2023 04:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Index Related to the Index class or subclasses Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: get_indexer returns non-matching with -1 positional
6 participants