Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Added breakpoints b/w coding examples in Installing Selenium #1892

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

Conversation

@shbenzer
Copy link
Contributor

@shbenzer shbenzer commented Aug 25, 2024
edited by qodo-merge-pro bot
Loading

User description

Installing Selenium's code examples had the section squished together; I added breakpoints b/w squished sections

Description

added breakpoints in coding examples of install_library.mds of each language

Motivation and Context

Increases readability

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

  • Added HTML breakpoints (<br>) between code examples in the installation documentation for Selenium.
  • Improved readability across multiple language versions: English, Japanese, Portuguese (Brazil), and Chinese.
  • Ensured consistent formatting and spacing in code examples to enhance user experience.

Changes walkthrough 📝

Relevant files
Documentation
install_library.en.md
Add HTML breakpoints for better readability in English doc

website_and_docs/content/documentation/webdriver/getting_started/install_library.en.md

  • Added HTML breakpoints (
    ) between code examples.
  • Improved readability of the installation instructions.
  • +6/-0
    install_library.ja.md
    Add HTML breakpoints for better readability in Japanese doc

    website_and_docs/content/documentation/webdriver/getting_started/install_library.ja.md

  • Added HTML breakpoints (
    ) between code examples.
  • Enhanced readability of the Japanese installation instructions.
  • +6/-0
    install_library.pt-br.md
    Add HTML breakpoints for better readability in Portuguese doc

    website_and_docs/content/documentation/webdriver/getting_started/install_library.pt-br.md

  • Added HTML breakpoints (
    ) between code examples.
  • Improved readability of the Portuguese (Brazil) installation
    instructions.
  • +6/-0
    install_library.zh-cn.md
    Add HTML breakpoints for better readability in Chinese doc

    website_and_docs/content/documentation/webdriver/getting_started/install_library.zh-cn.md

  • Added HTML breakpoints (
    ) between code examples.
  • Enhanced readability of the Chinese installation instructions.
  • +6/-0

    💡 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 Aug 25, 2024
    edited
    Loading

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit d99cbbf

    @qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Aug 25, 2024
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    No key issues to review

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion Score
    Best practice
    Use Markdown's native line break syntax instead of HTML tags

    Instead of using
    tags for line breaks, consider using Markdown's native line break
    syntax. In Markdown, you can create a line break by adding two spaces at the end of
    a line or by using a blank line between content.

    website_and_docs/content/documentation/webdriver/getting_started/install_library.en.md [46-49]

     ```shell
     pip install selenium

    -

    
    - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 -->
    <details><summary>Suggestion importance[1-10]: 8</summary>
    Why: The suggestion correctly identifies the use of HTML `<br>` tags in a Markdown document and recommends using Markdown's native line break syntax for better readability and adherence to Markdown standards.
    </details></details></td><td align=center>8
    </td></tr><tr><td rowspan=3><strong>Consistency</strong></td>
    <td>
    <details><summary>Maintain consistency in line break syntax across all language versions</summary>
    ___
    **For consistency across all language versions of the documentation, consider using <br>the same line break approach as suggested for the English version. Replace <code><br> </code> tags <br>with Markdown's native line break syntax.**
    [website_and_docs/content/documentation/webdriver/getting_started/install_library.ja.md [44-47]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1892/files#diff-2ce6683412ee6db6821c0bcd53f789cfe39be4fa4a981b2486a15ed50e8d4cecR44-R47)
    ```diff
     ```shell
     pip install selenium
    

    -

    
    - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=1 -->
    <details><summary>Suggestion importance[1-10]: 8</summary>
    Why: This suggestion promotes consistency across different language versions of the documentation by recommending the use of Markdown's native line break syntax, which is a best practice.
    </details></details></td><td align=center>8
    </td></tr><tr><td>
    <details><summary>Standardize line break syntax across all language versions of the documentation</summary>
    ___
    **To maintain consistency and follow Markdown best practices, replace the <code><br> </code> tags with <br>Markdown's native line break syntax, as suggested for the English and Japanese <br>versions.**
    [website_and_docs/content/documentation/webdriver/getting_started/install_library.pt-br.md [46-49]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1892/files#diff-e9b279344f8d2e5794747fd53c96d55dbc175ab21d018bb01afb6c1dd01376ddR46-R49)
    ```diff
     ```shell
     pip install selenium
    

    -

    
    - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=2 -->
    <details><summary>Suggestion importance[1-10]: 8</summary>
    Why: The suggestion is valid as it encourages the use of Markdown's native line break syntax, ensuring consistency and adherence to best practices across multiple language versions.
    </details></details></td><td align=center>8
    </td></tr><tr><td>
    <details><summary>Align line break syntax with other language versions and Markdown standards</summary>
    ___
    **For consistency with other language versions and to adhere to Markdown best <br>practices, replace the <code><br> </code> tags with Markdown's native line break syntax.**
    [website_and_docs/content/documentation/webdriver/getting_started/install_library.zh-cn.md [44-47]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1892/files#diff-23e25357b1fa69b927ae6def863091e7d861394c4224d3f22cca020bad368f6eR44-R47)
    ```diff
     ```shell
     pip install selenium
    

    -

    
    - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=3 -->
    <details><summary>Suggestion importance[1-10]: 8</summary>
    Why: This suggestion is appropriate as it aligns with the goal of maintaining consistency and following Markdown best practices by replacing HTML `<br>` tags with Markdown's native line break syntax.
    </details></details></td><td align=center>8
    </td></tr></tr></tbody></table>
    

    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.

    Thank you @shbenzer !

    @harsha509 harsha509 merged commit 3688b1e into SeleniumHQ:trunk Aug 26, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @harsha509 harsha509 harsha509 approved these changes

    Assignees

    No one assigned

    Labels

    documentation Improvements or additions to documentation Review effort [1-5]: 1

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    AltStyle によって変換されたページ (->オリジナル) /