Skip to content

tiny grammar change: remove use of word 'so' #1681

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

Merged
merged 2 commits into from
Apr 23, 2024
Merged

Conversation

zipperer
Copy link
Contributor

@zipperer zipperer commented Apr 21, 2024

User description

Description

I edited one sentence to remove a word that I deem unnecessary.
The sentence I edited begins with 'since'.
Because it begins with 'since', the second clause of the sentence is a conclusion.
'so' indicates a conclusion follows.
The sentence I edited used both 'since' and 'so', but 'since' is enough to indicate a conclusion follows, so I remove 'so'.

Motivation and Context

The change improves the flow of the sentence.


Type

Documentation


Description

  • This PR improves the documentation by editing a sentence to remove the redundant conjunction 'so', enhancing readability and grammatical correctness.

Changes walkthrough

Relevant files
Documentation
waits.en.md
Improve Grammar by Removing Redundant Conjunction               

website_and_docs/content/documentation/webdriver/waits.en.md

  • Removed the word 'so' to improve sentence flow and avoid redundancy in
    conjunction usage.
  • +1/-1     

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

    The sentence I edited begins with 'since'.
    Because it begins with 'since', the second clause
    of the sentence is a conclusion. 'so' indicates
    a conclusion follows. The sentence I edited used both
    'since' and 'so', but 'since' is enough to indicate
    a conclusion follows, so I remove 'so'.
    Copy link

    netlify bot commented Apr 21, 2024

    Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit 5047b45
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/6627ab4c8205a2000879529e
    😎 Deploy Preview https://deploy-preview-1681--selenium-dev.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @CLAassistant
    Copy link

    CLAassistant commented Apr 21, 2024

    CLA assistant check
    All committers have signed the CLA.

    @qodo-merge-pro qodo-merge-pro bot added the documentation Improvements or additions to documentation label Apr 21, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (ab1f34f)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the PR involves a very simple change in documentation, removing a single word to improve grammatical correctness. It is straightforward and requires minimal effort to review.

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 Security concerns

    No


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Enhancement
    Improve sentence clarity and coherence.

    Consider rephrasing the sentence to improve clarity and readability. Removing "so" might
    make the sentence less connected. A slight rewording could enhance the flow and coherence.

    website_and_docs/content/documentation/webdriver/waits.en.md [95]

    -explicit waits are a great choice to specify the exact condition to wait for
    +explicit waits are an excellent choice for specifying the exact condition to wait for
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    • When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

    See the improve usage page for a comprehensive guide on using this tool.

    Copy link
    Member

    @diemol diemol left a comment

    Choose a reason for hiding this comment

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

    Thank you, @zipperer!

    @diemol diemol merged commit 4d74a82 into SeleniumHQ:trunk Apr 23, 2024
    6 checks passed
    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]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants