Skip to content

[🚀 Feature]: Link to Documentation in Error Messages #11512

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
titusfortner opened this issue Jan 4, 2023 · 9 comments
Closed

[🚀 Feature]: Link to Documentation in Error Messages #11512

titusfortner opened this issue Jan 4, 2023 · 9 comments
Labels
A-needs new owner TLC has agreed to do this, but no one is assigned I-enhancement Something could be better J-stale Applied to issues that become stale, and eventually closed. R-help wanted Issues looking for contributions

Comments

@titusfortner
Copy link
Member

titusfortner commented Jan 4, 2023

Feature and motivation

Java currently adds links to our documentation for various error messages (https://github.com/SeleniumHQ/selenium/blob/selenium-4.7.0/java/src/org/openqa/selenium/WebDriverException.java#L78)

We should add basic descriptions for all of the errors in our docs, and we should add links to these in all of the bindings.

@titusfortner titusfortner added A-needs decision TLC needs to discuss and agree I-enhancement Something could be better labels Jan 4, 2023
@diemol
Copy link
Member

diemol commented Jan 31, 2023

During the TLC meeting held on January 19, 2023, it was decided that we want to work on this. However, we need to figure out what error messages we want to explain better to the users.

@titusfortner did you have some ideas on which messages we want to explain better?

@diemol diemol removed the A-needs decision TLC needs to discuss and agree label Jan 31, 2023
@titusfortner
Copy link
Member Author

I mean, we can list everything from w3c list and at very least copy paste the description from the spec

@diemol
Copy link
Member

diemol commented Feb 1, 2023

OK, that makes sense. Do we now need to check the bindings code and see where we want to link the error messages? Or would it be a single link in all exceptions and users find the error in the page we build?

@diemol diemol added the A-needs new owner TLC has agreed to do this, but no one is assigned label May 31, 2023
@titusfortner titusfortner self-assigned this Jun 8, 2023
@titusfortner
Copy link
Member Author

This is related to — #13378

@titusfortner titusfortner removed their assignment Dec 31, 2023
@titusfortner titusfortner added the R-help wanted Issues looking for contributions label Dec 31, 2023
Copy link

This issue is looking for contributors.

Please comment below or reach out to us through our IRC/Slack/Matrix channels if you are interested.

@aguspe
Copy link
Contributor

aguspe commented Jun 22, 2024

@titusfortner I started by adding dynamic url generation based on the error class names, afterwards I will add the respective documentation files

Copy link

This issue is stale because it has been open 280 days with no activity. Remove stale label or comment or this will be closed in 14 days.

@github-actions github-actions bot added the J-stale Applied to issues that become stale, and eventually closed. label Jan 24, 2025
Copy link

github-actions bot commented Feb 7, 2025

This issue was closed because it has been stalled for 14 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Feb 7, 2025
Copy link

github-actions bot commented Mar 9, 2025

This issue has been automatically locked since there has not been any recent activity since it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked and limited conversation to collaborators Mar 9, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-needs new owner TLC has agreed to do this, but no one is assigned I-enhancement Something could be better J-stale Applied to issues that become stale, and eventually closed. R-help wanted Issues looking for contributions
Projects
None yet
Development

No branches or pull requests

3 participants