Skip to content

[doc] "history and license" link has wrong target #89892

Closed

Description

@programmerjake
BPO 45729
Nosy @merwok, @JulienPalard, @miss-islington, @programmerjake
PRs
  • bpo-45729: [doc] Add license_url for python-docs-theme 2022.1. #30527
  • [3.10] [doc] bpo-45729: Add license_url for python-docs-theme 2022.1. (GH-30527) #30540
  • [3.9] [doc] bpo-45729: Add license_url for python-docs-theme 2022.1. (GH-30527) #30541
  • 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 = <Date 2022-01-12.10:19:18.467>
    created_at = <Date 2021-11-05.16:06:13.804>
    labels = ['3.11', 'type-bug', '3.9', '3.10', 'docs']
    title = '[doc] "history and license" link has wrong target'
    updated_at = <Date 2022-01-13.15:42:25.845>
    user = 'https://github.com/programmerjake'

    bugs.python.org fields:

    activity = <Date 2022-01-13.15:42:25.845>
    actor = 'mdk'
    assignee = 'docs@python'
    closed = True
    closed_date = <Date 2022-01-12.10:19:18.467>
    closer = 'mdk'
    components = ['Documentation']
    creation = <Date 2021-11-05.16:06:13.804>
    creator = 'programmerjake'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 45729
    keywords = ['patch']
    message_count = 8.0
    messages = ['405807', '405818', '405820', '405822', '410284', '410390', '410411', '410494']
    nosy_count = 5.0
    nosy_names = ['eric.araujo', 'docs@python', 'mdk', 'miss-islington', 'programmerjake']
    pr_nums = ['30527', '30540', '30541']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue45729'
    versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    Activity

    1. programmerjake commented on Nov 5, 2021

      programmerjakemannequin
      MannequinAuthor

      https://docs.python.org/3.10/library/csv.html
      at the bottom the "history and license" link just links back to csv.html, rather than the correct target.

    2. merwok commented on Nov 5, 2021

      @merwok
      Member

      It happens on all pages for all versions, because the link is empty.
      3.8 doesn’t have that line so doesn’t show the bug. I am trying to find where that is defined. Strangely, I don’t find results looking for please donate which is the line below…

    3. added
      3.11only security fixes
      type-bugAn unexpected behavior, bug, or error
      on Nov 5, 2021
    4. changed the title [-]"history and license" link has wrong target[/-] [+][doc] "history and license" link has wrong target[/+] on Nov 5, 2021
    5. changed the title [-]"history and license" link has wrong target[/-] [+][doc] "history and license" link has wrong target[/+] on Nov 5, 2021
    6. merwok commented on Nov 5, 2021

      @merwok
      Member

      Tracked to python/python-docs-theme#89

      AlexWaygood: can I ask why add pseudo-tags to the title field when we do have structured data (components set to doc) on this tracker? Is it a new practice?

    7. AlexWaygood commented on Nov 5, 2021

      @AlexWaygood
      Member

      @Éric: I personally found it difficult to immediately understand what the issue was about when reading only the title on the BPO homepage, and thought the change in title would help clarify, having seen other documentation issues marked similarly on the tracker.

    8. JulienPalard commented on Jan 11, 2022

      @JulienPalard
      Member

      This should be fixed in python-docs-theme==2022.1.

      I'll close the issue when I actually see the fix applied on docs.python.org.

    9. JulienPalard commented on Jan 12, 2022

      @JulienPalard
      Member

      I checked on docs.python.org and it's fixed.

    10. merwok commented on Jan 12, 2022

      @merwok
      Member

      dev docs direct to /license.html which redirects to /3/license.html

      3.9 docs have the same; wouldn’t it be better to have /3.9/license.html?

    11. JulienPalard commented on Jan 13, 2022

      @JulienPalard
      Member

      dev docs direct to /license.html which redirects to /3/license.html

      All docs are redirecting to /license.html, this allow it to work also out of docs.python.org.

      3.9 docs have the same; wouldn’t it be better to have /3.9/license.html?

      It's maybe a slight better yes (the page should be the same so I don't know if it make real difference), but doing so means a bit of complexity, which I don't think is worth it.

      I tried to keep it simple for this fix (the previous state was "links to the current page" which was worse).

    12. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirtype-bugAn unexpected behavior, bug, or error

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions