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.

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

Jump to bottom

set/frozenset methods intermixed in search, wrong results and target page anchor #113746

Open
tuttle opened this issue Jan 5, 2024 · 3 comments
Open

set/frozenset methods intermixed in search, wrong results and target page anchor #113746

tuttle opened this issue Jan 5, 2024 · 3 comments
Labels
docs Documentation in the Doc dir

Comments

@tuttle
Copy link

tuttle commented Jan 5, 2024 •
edited by bedevere-app bot
Loading

Searching for update shows these results:

https://docs.python.org/3.13/search.html?q=update

The search result list includes frozenset.update, which is false: frozenset does not have such method.

I guess this is due to the fact that on the target page https://docs.python.org/3.13/library/stdtypes.html#frozenset.update, set and frozenset are explained together, but the search indexer doesn't catch it.

#frozenset.update is even the working page anchor, while #set.update is not. More confusion.

Further, I'm guessing that this will be happening with more class groups documented together.

Linked PRs
@tuttle tuttle added the docs Documentation in the Doc dir label Jan 5, 2024
@vaishnavi192
Copy link
Contributor

hey @tuttle I would like to work on it. In which file I have to make changes?

@tuttle
Copy link
Author

tuttle commented Jan 6, 2024

Thanks! Anyway, I don't know, I'm sorry. :-)
Just reporting what I found out.
In my opinion, first you need to decide whether to modify either the search indexer or the source documentation.

koyuki7w added a commit to koyuki7w/cpython that referenced this issue Mar 4, 2025
@koyuki7w
pythongh-113746: Fix set and frozenset documents
Loading
Loading status checks…
32020d7 
Divided the class description into a part about sets and a part about frozensets.
Also, cleaned up the explanation of the comparison method.

Fixed pythongh-113746.
@koyuki7w koyuki7w mentioned this issue Mar 4, 2025
Closed
@skirpichev
Copy link
Member

See also #114336

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-113746: Fix set and frozenset documents koyuki7w/cpython
3 participants
@tuttle @skirpichev @vaishnavi192