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

Correct wrong file path in options to provide the right browser version ruby example #1701

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
diemol merged 1 commit into SeleniumHQ:trunk from aguspe:fix_small_options_bug
Apr 30, 2024

Conversation

@aguspe
Copy link
Contributor

@aguspe aguspe commented Apr 29, 2024 •
edited
Loading

User description

Description

While creating #1679 I accidentally mapped the wrong path to the options example, this PR fixes that path

Motivation and Context

It's important to provide Selenium users with high-quality examples in the docs so they can use it in the best possible way, right now the example for the browser version looks like this:

Screenshot 2024年04月29日 at 23 19 11

Which is not helpful for selenium users

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.

Type

documentation

Description

  • Corrected the file path in Ruby code examples across multiple language versions of the documentation.
  • Ensured that the Ruby examples point to the correct script (options_spec.rb) improving the accuracy and usefulness of the documentation.

Changes walkthrough

Relevant files
Documentation
options.en.md
Fix Incorrect Ruby Example Path in English Documentation

website_and_docs/content/documentation/webdriver/drivers/options.en.md

  • Corrected the file path in the Ruby code block from service_spec.rb to
    options_spec.rb.
    • +1/-1
    options.ja.md
    Update Ruby Example Path in Japanese Documentation

    website_and_docs/content/documentation/webdriver/drivers/options.ja.md

  • Updated the file path in the Ruby code block from service_spec.rb to
    options_spec.rb.
    • +1/-1
    options.pt-br.md
    Correct Ruby Example Path in Brazilian Portuguese Documentation

    website_and_docs/content/documentation/webdriver/drivers/options.pt-br.md

  • Changed the file path in the Ruby code block from service_spec.rb to
    options_spec.rb.
    • +1/-1
    options.zh-cn.md
    Update Ruby Example Path in Chinese Documentation

    website_and_docs/content/documentation/webdriver/drivers/options.zh-cn.md

  • Modified the file path in the Ruby code block from service_spec.rb to
    options_spec.rb.
    • +1/-1

    ✨ 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 Apr 29, 2024

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit fe4bb8c

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

    PR Description updated to latest commit (fe4bb8c)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the changes are straightforward and only involve updating file paths in documentation examples. The scope is limited and the impact is clear, making it a quick 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

    No code suggestions found for PR.

    Copy link
    Contributor Author

    aguspe commented Apr 29, 2024

    Hi @harsha509 this small fix provides better examples on options while I continue working on my separate PR to add examples to http://localhost:60031/documentation/webdriver/drivers/http_client/

    I will push it after this changes are merged :) thank you for the help

    Copy link
    Member

    Hi @aguspe ,

    Could you please complete checklist above ?

    Thanks,
    Sri

    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, @aguspe!

    @diemol diemol merged commit 536080e into SeleniumHQ:trunk Apr 30, 2024
    selenium-ci added a commit that referenced this pull request Apr 30, 2024 
    ...on ruby example (#1701)
Correct wrong file path
Co-authored-by: aguspe <agustin.pe94@gmail.com>
[deploy site] 536080e
    Copy link
    Contributor Author

    aguspe commented Apr 30, 2024

    Hi @aguspe ,

    Could you please complete checklist above ?

    Thanks, Sri

    Hi @harsha509 and @diemol thank you for the approval, I updated the checklist now, have a nice evening!

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @diemol diemol diemol approved these changes

    @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 によって変換されたページ (->オリジナル) /