Skip to content

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

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

Closed
jordibc opened this issue Jul 29, 2024 · 4 comments
Closed
Labels
docs Documentation in the Doc dir

Comments

@jordibc
Copy link
Contributor

jordibc commented Jul 29, 2024

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

@jordibc jordibc added the docs Documentation in the Doc dir label Jul 29, 2024
@AA-Turner
Copy link
Member

Would you be willing to open a PR?

A

jordibc added a commit to jordibc/cpython that referenced this issue Jul 29, 2024
This is a minor change that addresses python#122399

It just mentions that the controller object has a `name` attribute too, before mentioning it with the other methods.
@jordibc
Copy link
Contributor Author

jordibc commented Jul 29, 2024

@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).

jordibc added a commit to jordibc/cpython that referenced this issue Jul 29, 2024
…ts of controller object

This is a minor change that addresses python#122399 (for the 3.12 branch).

It fixes the reference to the attribute `name` so it belongs to the controller object (and not to the webbrowser module).

It also mentions that the controller object has a name attribute too, before mentioning it with the other methods.
@jordibc
Copy link
Contributor Author

jordibc commented Jul 29, 2024

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

@AA-Turner
Copy link
Member

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

A

hugovk pushed a commit that referenced this issue Apr 24, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 24, 2025
…s of controller object (pythonGH-122407)

(cherry picked from commit 1583f9c)

Co-authored-by: Jordi Burguet-Castell <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
hugovk pushed a commit that referenced this issue Apr 24, 2025
…ts of controller object (GH-122407) (#132874)

Co-authored-by: Jordi Burguet-Castell <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
@hugovk hugovk closed this as completed Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

3 participants