GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Minor error in the doc for controller.name in the webbrowser documentation page · Issue #122399 · python/cpython

Minor error in the doc for controller.name in the webbrowser documentation page #122399

New issue
Copy link
New issue
Copy link
Closed
Closed
Minor error in the doc for controller.name in the webbrowser documentation page#122399
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir

Description

@jordibc
jordibc
opened on Jul 29, 2024
Issue body actions

Documentation

In https://docs.python.org/3/library/webbrowser.html#browser-controller-objects it says:

 webbrowser.name
    System-dependent name for the browser.

when it should be controller instead of webbrowser (it is the controller object that has the name attribute, not the webbrowser module).

In addition to that, I think that the first sentence,

Browser controllers provide these methods which parallel three of the module-level convenience functions:

would probably be better with something like:

Browser controllers provide the `name` attribute, and these methods which parallel three of the module-level convenience functions:

Thanks!

Linked PRs

  • gh-122399: change webbrowser.rst to better describe the contents of controller object #122407
  • gh-122399: change webbrowser.rst to better describe the contents of controller object #122410
  • [3.13] gh-122399: change webbrowser.rst to better describe the contents of controller object (GH-122407) #132874

Activity

  1. jordibc
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Jul 29, 2024
  2. AA-Turner commented on Jul 29, 2024

    @AA-Turner
    AA-Turner
    on Jul 29, 2024
    Member
    More actions

    Would you be willing to open a PR?

    A

  3. jordibc
    added a commit that references this issue on Jul 29, 2024

    webbrowser.rst: better describe the contents of controller object

    559b1e9
  4. jordibc commented on Jul 29, 2024

    @jordibc
    jordibc
    on Jul 29, 2024
    ContributorAuthor
    More actions

    @AA-Turner Sure! I just did in #122407 .

    It turns out that for the documentation in dev, the main part was already changed (webbrowser -> controller). So I just added the second part (mentioning the name attribute).

  5. jordibc
    added a commit that references this issue on Jul 29, 2024

    pythongh-122399: change webbrowser.rst to better describe the conten…

    af52ff7
  6. jordibc commented on Jul 29, 2024

    @jordibc
    jordibc
    on Jul 29, 2024
    ContributorAuthor
    More actions

    And this is the PR with the complete change for the branch with the last stable release (3.12): #122410

  7. AA-Turner commented on Jul 29, 2024

    @AA-Turner
    AA-Turner
    on Jul 29, 2024
    Member
    More actions

    #105546 fixed controller.name but wasn't backported for obvious reasons.

    A

  8. hugovk
    added a commit that references this issue on Apr 24, 2025

    gh-122399: change webbrowser.rst to better describe the contents of c…

    1583f9c
  9. miss-islington
    added a commit that references this issue on Apr 24, 2025

    pythongh-122399: change webbrowser.rst to better describe the content…

    1ed6783
  10. hugovk
    added a commit that references this issue on Apr 24, 2025

    [3.13] gh-122399: change webbrowser.rst to better describe the conten…

    bd4a39f
  11. hugovk
    closed this as completedon Apr 24, 2025
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

    docsDocumentation in the Doc dirDocumentation in the Doc dir

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402503 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.