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

updated exceptions to reflect error messages #1944

Closed
wants to merge 1 commit into from

Conversation

shbenzer
Copy link
Contributor

@shbenzer shbenzer commented Sep 14, 2024

User description

Updated the Common Exceptions Page headers to reflect what users will see in their error messages

Description

updated index.md in all languages

Motivation and Context

enhance readability, user comprehension, and seo optimization

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

documentation


Description

  • Updated exception headers across multiple language documentation files to reflect actual error messages.
  • Improved consistency and clarity by aligning documentation with error message formats.
  • Enhanced readability and user comprehension by using precise exception names.

Changes walkthrough 📝

Relevant files
Documentation
_index.en.md
Update exception headers to match error messages in English
documentation

website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.en.md

  • Updated exception headers to match error messages.
  • Changed "Invalid Selector Exception" to "InvalidSelectorException".
  • Changed "No Such Element Exception" to "NoSuchElementException".
  • Changed "Stale Element Reference Exception" to
    "StaleElementReferenceException".
  • Changed "Invalid SessionId Exception" to "InvalidSessionIdException".
  • +4/-4     
    _index.ja.md
    Update exception headers to match error messages in Japanese
    documentation

    website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.ja.md

  • Updated exception headers to match error messages.
  • Changed "Invalid Selector Exception" to "InvalidSelectorException".
  • Changed "No Such Element Exception" to "NoSuchElementException".
  • Changed "Stale Element Reference Exception" to
    "StaleElementReferenceException".
  • Changed "Invalid SessionId Exception" to "InvalidSessionIdException".
  • +4/-4     
    _index.pt-br.md
    Update exception headers to match error messages in Portuguese
    documentation

    website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.pt-br.md

  • Updated exception headers to match error messages.
  • Changed "Invalid Selector Exception" to "InvalidSelectorException".
  • Changed "No Such Element Exception" to "NoSuchElementException".
  • Changed "Stale Element Reference Exception" to
    "StaleElementReferenceException".
  • Changed "Invalid SessionId Exception" to "InvalidSessionIdException".
  • +4/-4     
    _index.zh-cn.md
    Update exception headers to match error messages in Chinese
    documentation

    website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.zh-cn.md

  • Updated exception headers to match error messages.
  • Changed "Invalid Selector Exception" to "InvalidSelectorException".
  • Changed "No Such Element Exception" to "NoSuchElementException".
  • Changed "Stale Element Reference Exception" to
    "StaleElementReferenceException".
  • Changed "Invalid SessionId Exception" to "InvalidSessionIdException".
  • +4/-4     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link

    netlify bot commented Sep 14, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 227ef71

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 2 labels Sep 14, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    Consistency
    Ensure that the exception names are consistently formatted across all language versions of the documentation.

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Consistency
    Update the Chinese translation of the exception name to maintain consistency with other translations

    Consider updating the Chinese translation of "InvalidSessionIdException" to
    "无效会话ID异常 (InvalidSessionIdException)" to maintain consistency with the naming
    convention used for other exceptions in this file.

    website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.zh-cn.md [102]

    -+## 无效SessionId异常
    ++## 无效会话ID异常 (InvalidSessionIdException)
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: The suggestion improves consistency in the document by aligning the translation format of "InvalidSessionIdException" with other exceptions, enhancing readability and uniformity.

    9

    @shbenzer shbenzer closed this Sep 23, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant