Skip to content

DOC: Fix typo of =! to != in docstring #36077

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 1 commit into from
Sep 2, 2020

Conversation

daytonb
Copy link
Contributor

@daytonb daytonb commented Sep 2, 2020

This fixes GH36075.

I'm marking the following list items as not-applicable because I'm simply swapping two characters in a docstring that had been in the incorrect order.

  • [NA] tests added / passed
  • [NA] passes black pandas
  • [NA] passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • [NA] whatsnew entry

Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

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

Thanks @daytonb lgtm pending green

@simonjayhawkins simonjayhawkins added this to the 1.2 milestone Sep 2, 2020
@MarcoGorelli MarcoGorelli merged commit f635d17 into pandas-dev:master Sep 2, 2020
@MarcoGorelli
Copy link
Member

Thanks @daytonb !

@daytonb
Copy link
Contributor Author

daytonb commented Sep 2, 2020

Thanks! It's been a pleasure. Thanks for the quick merge.

@daytonb daytonb deleted the ne-docstring-fix branch September 2, 2020 19:35
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
@sjawhar
Copy link

sjawhar commented Apr 2, 2021

So this change actually breaks building docs, at least using sphinx. Leads to an error

/usr/local/lib/python3.8/site-packages/docutils/nodes.py", line 567, in __getitem__
    return self.attributes[key]
KeyError: 'reftarget'

whereas simply swapping them back fixes the problem. Any idea what might be going on here?

@daytonb
Copy link
Contributor Author

daytonb commented Apr 2, 2021 via email

@daytonb
Copy link
Contributor Author

daytonb commented Apr 7, 2021

@sjawhar, can you give me the steps you ran to reproduce this issue? It seams unlikely that my text change could lead to the error you posted. Also, when I my docstring change is already part of the current (v1.2.3) release and the documentation is rendered properly online, all of which seems to indicate that this docstring change isn't the cause of the issue you're reporting. If you can give me some steps to reproduce, I'd be happy to try to figure out what's going on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Docstring for comparison operators has "=!" instead of "!="
4 participants