search

SeleniumHQ / seleniumhq.github.io

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

removed hanging '>' #1896

Closed shbenzer closed 2 weeks ago

shbenzer commented 2 weeks ago

User description

there was a hanging '>' character in locator strategies

Description

removed hanging '>' character at the end of Utilizing Locators section description in all languages also ensured line-count was below 100 chars in the descriptions of all languages for Utilizing Locators

Motivation and Context

increases readability

Types of changes

Checklist

PR Type

documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
locators.en.md
Fix formatting and remove extraneous character in English locators
documentation
website_and_docs/content/documentation/webdriver/elements/locators.en.md
  • Removed a hanging '>' character.
  • Reformatted text to ensure line length is below 100 characters.
    		•  +3/-1     
    locators.ja.md
    Fix formatting and remove extraneous character in Japanese locators
    documentation
    website_and_docs/content/documentation/webdriver/elements/locators.ja.md
  • Removed a hanging '>' character.
  • Reformatted text to ensure line length is below 100 characters.
    		•  +3/-1     
    locators.pt-br.md
    Fix formatting and remove extraneous character in Portuguese locators
    documentation
    website_and_docs/content/documentation/webdriver/elements/locators.pt-br.md
  • Removed a hanging '>' character.
  • Reformatted text to ensure line length is below 100 characters.
    		•  +3/-1     
    locators.zh-cn.md
    Fix formatting and remove extraneous character in Chinese locators
    documentation
    website_and_docs/content/documentation/webdriver/elements/locators.zh-cn.md
  • Removed a hanging '>' character.
  • Reformatted text to ensure line length is below 100 characters.
    		•  +3/-1     

    💡 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 weeks ago

    Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    Latest commit deab10399d5012530691f5a63fda81aa395a4a9d
    codiumai-pr-agent-pro[bot] commented 2 weeks 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 weeks ago

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Correct the capitalization of a method name to follow common naming conventions ___ **Consider capitalizing 'FindElement' to 'findElement' as it's typically written in
    camelCase in most programming languages.** [website_and_docs/content/documentation/webdriver/elements/locators.en.md [335-337]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1896/files#diff-bad5c08d78f84e8bd7528d1a2a3181973375147d3f8bc5b9678cfce7dbe76aabR335-R337) ```diff -The FindElement makes using locators a breeze! For most languages, +The findElement makes using locators a breeze! For most languages, all you need to do is utilize `webdriver.common.by.By`, however in -others it's as simple as setting a parameter in the FindElement function +others it's as simple as setting a parameter in the findElement function ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: The suggestion to use camelCase for 'findElement' aligns with common programming conventions, improving readability and consistency with typical method naming practices.
    		7
    Enhancement
    Add proper punctuation at the end of a sentence ___ **Consider adding a period at the end of the sentence to improve readability and
    maintain consistency in punctuation.** [website_and_docs/content/documentation/webdriver/elements/locators.en.md [335-337]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1896/files#diff-bad5c08d78f84e8bd7528d1a2a3181973375147d3f8bc5b9678cfce7dbe76aabR335-R337) ```diff The FindElement makes using locators a breeze! For most languages, all you need to do is utilize `webdriver.common.by.By`, however in -others it's as simple as setting a parameter in the FindElement function +others it's as simple as setting a parameter in the FindElement function. ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 5 Why: Adding a period at the end of the sentence enhances readability and maintains punctuation consistency, though it is a minor improvement.
    		5