SeleniumHQ / seleniumhq.github.io

Official Selenium website and documentation
https://selenium.dev
Apache License 2.0
1.09k stars 1.28k forks source link

Fixing English grammar #1803

Closed Nisim761 closed 2 months ago

Nisim761 commented 2 months ago

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

Checklist


PR Type

Documentation


Description


Changes walkthrough 📝

Relevant files
Documentation
page_object_models.en.md
Fix grammatical error and add newline in documentation     

website_and_docs/content/documentation/test_practices/encouraged/page_object_models.en.md
  • Corrected a grammatical error in the text.
  • Added a newline at the end of the file.
  • +2/-2     

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

    netlify[bot] commented 2 months ago

    Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    Latest commit 1562a957c76f762ea77dbf8cc87e53d7a0033607
    CLAassistant commented 2 months ago

    CLA assistant check
    All committers have signed the CLA.

    codiumai-pr-agent-pro[bot] commented 2 months ago

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No key issues to review
    codiumai-pr-agent-pro[bot] commented 2 months ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Readability
    Rephrase the sentence to improve readability and clarity ___ **To improve readability and clarity, consider rephrasing the sentence to avoid redundancy
    and make it more concise.** [website_and_docs/content/documentation/test_practices/encouraged/page_object_models.en.md [187]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1803/files#diff-cfc30f24cd0d69c4ac0bd17360cb46edb221a357b4e39c82851365bc931043eeR187-R187) ```diff -part of your test and should always be within the test’s code, never in a page +part of your test and should always be within the test code, never in a page ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 5 Why: The suggestion correctly identifies a minor redundancy in the text but the improvement is relatively minor and does not significantly enhance the clarity or readability of the document.
    5
    Nisim761 commented 2 months ago

    Hi @Nisim761 ,

    Thank you for the PR.

    To maintain consistency across all language versions, could you please replicate the changes you made on the main page to the other translated pages which are in English (pt-br, zh-cn, ja)?

    Thanks, Sri

    I am not really sure how. I only read the English version. I checked, couldn't find this error on other pages in English.

    harsha509 commented 2 months ago

    Hi @Nisim761 , Thank you for the PR. To maintain consistency across all language versions, could you please replicate the changes you made on the main page to the other translated pages which are in English (pt-br, zh-cn, ja)? Thanks, Sri

    I am not really sure how. I only read the English version. I checked, couldn't find this error on other pages in English.

    No worries, i have updated other pages with commit https://github.com/SeleniumHQ/seleniumhq.github.io/commit/fa62b405393ba396d9579fef35630489e6fea533 referring to this PR!

    Nisim761 commented 2 months ago

    Hi @Nisim761 , Thank you for the PR. To maintain consistency across all language versions, could you please replicate the changes you made on the main page to the other translated pages which are in English (pt-br, zh-cn, ja)? Thanks, Sri

    I am not really sure how. I only read the English version. I checked, couldn't find this error on other pages in English.

    No worries, i have updated other pages with commit fa62b40 referring to this PR!

    Thank you!