Skip to content

DOC: Docstring for comparison operators has "=!" instead of "!=" #36075

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

Closed
daytonb opened this issue Sep 2, 2020 · 5 comments · Fixed by #36077
Closed

DOC: Docstring for comparison operators has "=!" instead of "!=" #36075

daytonb opened this issue Sep 2, 2020 · 5 comments · Fixed by #36077
Assignees
Labels
Closing Candidate May be closeable, needs more eyeballs Docs

Comments

@daytonb
Copy link
Contributor

daytonb commented Sep 2, 2020

Location of the documentation

Shows up in all the flexible comparison docstrings like "https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.ne.html". The typo is in the _flex_comp_doc_FRAME shared docstring found in core/ops/docstrings.py.

Documentation problem

The docstring says =! instead of != for the not-equals comparison.

Suggested fix for documentation

Just need to change it to !=.

@daytonb daytonb added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 2, 2020
@daytonb
Copy link
Contributor Author

daytonb commented Sep 2, 2020

take

daytonb added a commit to daytonb/pandas that referenced this issue Sep 2, 2020
@MarcoGorelli MarcoGorelli removed the Needs Triage Issue that has not been reviewed by a pandas team member label Sep 2, 2020
@simonjayhawkins simonjayhawkins added this to the 1.2 milestone Sep 2, 2020
@MarcoGorelli MarcoGorelli reopened this Apr 3, 2021
@MarcoGorelli
Copy link
Member

From a comment on the PR #36077 (comment):

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?

I haven't yet looked into it, just reopening so it's not forgotten

@simonjayhawkins simonjayhawkins removed this from the 1.2 milestone Apr 13, 2021
@jbrockmendel
Copy link
Member

@MarcoGorelli is there anything left to do here?

@jbrockmendel jbrockmendel added the Closing Candidate May be closeable, needs more eyeballs label Dec 21, 2021
@daytonb
Copy link
Contributor Author

daytonb commented Jan 19, 2022

@jbrockmendel and @MarcoGorelli, I don't believe there is anything left to do here. I was pretty certain that my tiny docstring correction could not have broken building the docs and my commit has been part of the main line for quite a while now including several pandas releases. This tells me that whatever was actually causing the doc build failures has also been addressed by some other work.

@MarcoGorelli
Copy link
Member

Agreed, thanks for closing, looks like I just forgot to get back to this, sorry 😞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closing Candidate May be closeable, needs more eyeballs Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants