SeleniumHQ / SeleniumHQ/seleniumhq.github.io

[🚀 Feature]: Expand Error Messages

Open
#1,276 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

hacktoberfest help wanted
Dominant language
HTML
Stars
1.4k
Forks
1.6k
Avg merge
18h 3m
Merged PRs (30d)
56

Description

Feature and motivation

We have a new Errors Page, but it only describes 3 errors, while there are 28 possible errors from WebDriver.

Each error should at least include the w3c description, and additional information provided in the spec.

e.g. insecure certificate has:

Navigation caused the user agent to hit a certificate warning, which is usually the result of an expired or invalid TLS certificate.

and then later in the spec it is referenced with:

If the current session’s secure TLS state is disabled, take implementation specific steps to ensure the navigation is not aborted and that the untrusted- or invalid TLS certificate error that would normally occur under these circumstances, are suppressed.

Otherwise return error with error code insecure certificate

If we provide this information in our documentation we can replace any descriptions in the error messages of each bindings with a link to the documentation.

Ideally we can also describe various causes of the errors and what someone should do if they get that error, but we can incrementally add to this page.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Selenium Errors Page and compare it with the WebDriver error-code specification linked in the issue. Document all 28 possible errors, including each W3C description and additional spec information; the work is done when the page covers the errors beyond its current three entries and supports linking to the documentation from binding error messages.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.