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

Fixing consistency and English grammar #1804

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from

Conversation

Nisim761
Copy link
Contributor

@Nisim761 Nisim761 commented Jul 9, 2024

User description

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

Motivation and Context

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

  • Improved grammar and consistency in the locators.en.md documentation file.
  • Clarified instructions on how to create locators using CSS selectors and XPath.
  • Corrected terminology and provided clearer examples for locating elements.

Changes walkthrough 📝

Relevant files
Documentation
locators.en.md
Improve grammar and consistency in locators documentation

website_and_docs/content/documentation/webdriver/elements/locators.en.md

  • Improved grammar and consistency in explanations.
  • Clarified instructions for creating locators.
  • Corrected terminology for XPath and CSS selectors.
  • +9/-9     

    💡 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 Jul 9, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit f017fef

    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added the documentation Improvements or additions to documentation label Jul 9, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

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

    Grammar Consistency:
    The changes made in the PR improve grammar and consistency, which is beneficial for documentation clarity. No major issues detected.

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    Correct the article usage for grammatical accuracy

    Correct the grammatical error by changing "A HTML" to "An HTML" for proper article
    usage before a vowel sound.

    website_and_docs/content/documentation/webdriver/elements/locators.en.md [298]

    -A HTML document can be considered as a XML document, and then we can use XPath
    +An HTML document can be considered as an XML document, and then we can use XPath
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: This correction addresses a clear grammatical error, enhancing the overall quality and professionalism of the documentation.

    9
    Enhancement
    Improve the clarity and grammatical structure of the sentence

    Revise the sentence for clarity and grammatical correctness. The phrase "using
    which" is awkward and can be simplified for better readability.

    website_and_docs/content/documentation/webdriver/elements/locators.en.md [37]

    -Selenium provides us above mentioned ways, using which we can locate an element on the
    +Selenium provides the above-mentioned methods, which we can use to locate an element on the
     
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: The suggestion improves readability and grammatical correctness, making the sentence clearer and more professional.

    8
    Enhance the readability and consistency of the XPath description

    Modify the sentence structure to enhance readability and maintain consistency in the
    description of XPath usage.

    website_and_docs/content/documentation/webdriver/elements/locators.en.md [302-303]

    -Or the Xpath could be relative. Example - //input[@name='fname']. This will return the
    +Alternatively, the XPath can be relative. For example, //input[@name='fname'] will return the
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion improves readability and maintains consistency, which is beneficial for understanding the documentation, though it is a minor enhancement.

    7
    Maintainability
    Improve sentence clarity and conciseness

    Revise the sentence to improve clarity and conciseness by removing unnecessary
    words.

    website_and_docs/content/documentation/webdriver/elements/locators.en.md [346]

    -Relative locator methods can take either a previously located element reference,
    +Relative locator methods can take a previously located element reference,
     
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: The suggestion makes the sentence more concise and easier to read, which is a minor but useful improvement for maintainability.

    6

    @Nisim761
    Copy link
    Contributor Author

    @harsha509 Can you please update what is missing?

    Copy link
    Member

    @harsha509 harsha509 left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    HI @Nisim761 ,

    Thanks for your PR.

    Could you also implement similar updates in other translated pages that are still in English?

    For reference, you can use this commit: fa62b40

    We have documentations that are maintained in 3 other languages:

    https://www.selenium.dev/ja/documentation/webdriver/elements/locators/
    https://www.selenium.dev/pt-br/documentation/webdriver/elements/locators/
    https://www.selenium.dev/zh-cn/documentation/webdriver/elements/locators/

    These need to be updated as well.

    Thanks,
    Sri

    Copy link

    @A1exKH A1exKH left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM.

    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.

    3 participants