cpython icon indicating copy to clipboard operation
cpython copied to clipboard

Links are duplicated in documentation search result

Open bf99f742-a7dd-4469-a2c9-884482a322fa opened this issue 6 years ago • 4 comments

BPO 38836
Nosy @JulienPalard, @MaT1g3R, @iritkatriel

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2019-11-18.16:55:04.644>
labels = ['3.11', 'type-bug', '3.9', '3.10', 'docs']
title = 'Links are duplicated in documentation search result'
updated_at = <Date 2021-12-06.10:57:16.467>
user = 'https://github.com/MaT1g3R'

bugs.python.org fields:

activity = <Date 2021-12-06.10:57:16.467>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-11-18.16:55:04.644>
creator = 'MaT1g3R'
dependencies = []
files = []
hgrepos = []
issue_num = 38836
keywords = []
message_count = 2.0
messages = ['356883', '407758']
nosy_count = 4.0
nosy_names = ['docs@python', 'mdk', 'MaT1g3R', 'iritkatriel']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38836'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

When I do a search in documentation, for example:

https://docs.python.org/3.9/search.html?q=os.walk

The links in the results are sometimes duplicated, for example this link below shows up twice in the search result:

https://docs.python.org/3.9/library/os.html?highlight=os%20walk#os.walk

On a Mac I was unable to reproduce this - the link to the search results give me a list of two items:

  1. os.walk linking to https://docs.python.org/3.9/library/os.html?highlight=os.walk#os.walk

  2. Changelog linking to https://docs.python.org/3.9/whatsnew/changelog.html?highlight=os.walk

However, on windows I got a list of 4 items:

  1. os.walk : https://docs.python.org/3.9/library/os.html?highlight=os%20walk#os.walk

  2. os.fwalk: https://docs.python.org/3.9/library/os.html?highlight=os%20walk#os.fwalk

  3. os.fwalk: https://docs.python.org/3.9/library/os.html?highlight=os%20walk#os.fwalk

  4. os.walk: https://docs.python.org/3.9/library/os.html?highlight=os%20walk#os.walk

In summary:

Mac didn't know os.fwalk. Windows didn't show the Changelog. Windows showed each link twice.

iritkatriel avatar Dec 05 '21 23:12 iritkatriel

On the current dev branch, search has changed: https://docs.python.org/dev/search.html?q=os.walk shows os.walk for my first search result and a bunch (100+) of other search results with all or parts of 'os.walk'. This is for Windows though, so unsure if it was changed on Mac.

slateny avatar Sep 01 '22 02:09 slateny

On Firefox 105 on Linux it works as @slateny mentioned in the last comment: it shows os.walk once then a bunch of semi-related results.

It looks OK to me.

JulienPalard avatar Oct 16 '22 09:10 JulienPalard

I'll close for now then, but feel free to reopen if the issue reoccurs.

slateny avatar Oct 17 '22 14:10 slateny