Skip to content
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

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

Open
titusfortner opened this issue Jan 4, 2023 · 6 comments
Open

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

titusfortner opened this issue Jan 4, 2023 · 6 comments
Labels

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.

@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?

@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?

@titusfortner
Copy link
Member Author

This is related to — #13378

@titusfortner titusfortner removed their assignment Dec 31, 2023
@titusfortner titusfortner added the 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants