Skip to content
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

Update link to pandas DataFrame query doc #872

Closed
wants to merge 1 commit into from

Conversation

victorlin
Copy link
Member

The section ID on the docs is now the-query-method. The ID indexing-query is on an invisible span element. It was probably an older section ID that's kept around on the span to make sure existing links still work. Updating the link to the new ID selector in case the empty span gets removed in the future.

The section ID on the docs is now `the-query-method`. The ID `indexing-query` is on an invisible `span` element. It was probably an older section ID that's kept around on the span to make sure existing links still work. Updating the link to the new ID selector in case the empty span gets removed in the future.
Copy link
Member

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

Ah, I think we should leave this as-is.

The "invisible span" with indexing-query is an explicit target/anchor in the source rST document and is intended as a stable cross-ref name. The "visible" section id of the-query-method arises from the implicit target/anchor created by the rST heading, which won't be stable over time if the heading text changes.

.. _indexing.query:

The :meth:`~pandas.DataFrame.query` Method
------------------------------------------

@victorlin
Copy link
Member Author

Ohh thanks for digging that up! Agree to leave it as-is then.

@victorlin victorlin closed this Apr 1, 2022
@victorlin victorlin deleted the victorlin/filter/update-query-doc-link branch April 1, 2022 19:13
@tsibley
Copy link
Member

tsibley commented Apr 1, 2022

I only thought to go look because having looked at the DOM of some Sphinx pages recently I'd noticed those empty spans with an id and knew what they corresponded to in the source docs I was using. :-)

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

Successfully merging this pull request may close these issues.

None yet

2 participants