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

[py] fix ie code line #2107

Merged
merged 1 commit into from
Dec 20, 2024
Merged

[py] fix ie code line #2107

merged 1 commit into from
Dec 20, 2024

Conversation

Delta456
Copy link
Contributor

@Delta456 Delta456 commented Dec 20, 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

Fix IE code line so that it correctly correspond to the heading

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

  • Fixed line number references in Python code examples across all language versions of the Internet Explorer documentation
  • Updated code block references to correctly correspond to the actual implementation
  • Synchronized line numbers between English, Japanese, Portuguese, and Chinese documentation
  • Ensured consistency in code example references across all translations

Changes walkthrough 📝

Relevant files
Documentation
internet_explorer.en.md
Update Python code block line references                                 

website_and_docs/content/documentation/webdriver/browsers/internet_explorer.en.md

  • Updated line number references in Python code examples to match
    correct sections
  • Fixed code block references to align with actual implementation
  • +7/-7     
    internet_explorer.ja.md
    Sync Japanese docs Python code references                               

    website_and_docs/content/documentation/webdriver/browsers/internet_explorer.ja.md

  • Updated Python code block line references to match English version
  • Synchronized code example line numbers with source file
  • +7/-7     
    internet_explorer.pt-br.md
    Update Portuguese docs Python references                                 

    website_and_docs/content/documentation/webdriver/browsers/internet_explorer.pt-br.md

  • Updated Python code block line references to match English version
  • Fixed code example line numbers for consistency
  • +7/-7     
    internet_explorer.zh-cn.md
    Sync Chinese docs Python code references                                 

    website_and_docs/content/documentation/webdriver/browsers/internet_explorer.zh-cn.md

  • Updated Python code block line references to match English version
  • Synchronized code example line numbers with source file
  • +7/-7     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link

    netlify bot commented Dec 20, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 951909f

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Formatting Error
    Line number reference has incorrect format - missing hyphen between line numbers (L121-123 instead of L121-L123)

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Fix incorrect line number reference format in code block to maintain consistency with other references

    Fix the incorrect line number range in the Python code block reference. The hyphen
    in "L121-123" is missing a "L" prefix for the end line number.

    website_and_docs/content/documentation/webdriver/browsers/internet_explorer.pt-br.md [578]

    -{{< gh-codeblock path="examples/python/tests/browsers/test_internet_explorer.py#L121-123" >}}
    +{{< gh-codeblock path="examples/python/tests/browsers/test_internet_explorer.py#L121-L123" >}}
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion fixes an inconsistency in line number reference format that could cause confusion or technical issues. The missing 'L' prefix in the end line number should match the format used throughout the documentation.

    7

    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 @Delta456 !

    @harsha509 harsha509 merged commit add39da into SeleniumHQ:trunk Dec 20, 2024
    3 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants