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

Update http client examples #1708

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
harsha509 merged 2 commits into SeleniumHQ:trunk from aguspe:update_httpc_client_reference
May 5, 2024

Conversation

@aguspe
Copy link
Contributor

@aguspe aguspe commented May 5, 2024 •
edited by qodo-merge-pro bot
Loading

User description

Description

This PR fixes the reference for the HTTP client examples

Motivation and Context

It's important that all the examples are correct so users can use them as a reference, currently they look like this:

Screenshot 2024年05月05日 at 13 33 02

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

  • Updated the Ruby example code block references across multiple language versions of the WebDriver HTTP client documentation.
  • Changes ensure that the documentation points to the correct lines of code in the Ruby examples.

Changes walkthrough

Relevant files
Documentation
http_client.en.md
Update Ruby code block reference in English documentation

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

  • Updated the Ruby code block reference from lines 9-10 to lines 7-8.
    • +1/-1
    http_client.ja.md
    Update Ruby code block reference in Japanese documentation

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

  • Updated the Ruby code block reference from lines 9-10 to lines 7-8.
    • +1/-1
    http_client.pt-br.md
    Update Ruby code block reference in Portuguese documentation

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

  • Updated the Ruby code block reference from lines 9-10 to lines 7-8.
    • +1/-1
    http_client.zh-cn.md
    Update Ruby code block reference in Chinese documentation

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

  • Updated the Ruby code block reference from lines 9-10 to lines 7-8.
    • +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 May 5, 2024 •
    edited
    Loading

    👷 Deploy request for selenium-dev pending review.

    Visit the deploys page to approve it

    Name Link
    🔨 Latest commit 5f57f96

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

    qodo-merge-pro bot commented May 5, 2024

    PR Description updated to latest commit (46486f3)

    Copy link
    Contributor

    qodo-merge-pro bot commented May 5, 2024

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the changes are minimal and straightforward, involving only updates to documentation references.

    🧪 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

    qodo-merge-pro bot commented May 5, 2024

    PR Code Suggestions

    CategorySuggestions
    Possible issue
    Verify and ensure the correctness of the updated code block references in the documentation.

    Ensure that the updated code block reference in the documentation points to a valid and
    relevant section of the Ruby example. Verify that the lines L7-L8 are the correct ones
    that should be highlighted for the users, as previously it was L9-L10.

    website_and_docs/content/documentation/webdriver/drivers/http_client.en.md [20] 

    -{{< gh-codeblock path="examples/ruby/spec/drivers/http_client_spec.rb#L7-L8" >}}
+{{< gh-codeblock path="examples/ruby/spec/drivers/http_client_spec.rb#L7-L8" >}} # Ensure this is the correct reference
    ✨ 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

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

    @harsha509 harsha509 merged commit 8587398 into SeleniumHQ:trunk May 5, 2024
    selenium-ci added a commit that referenced this pull request May 5, 2024 
    Co-authored-by: aguspe <agustin.pe94@gmail.com> 8587398
    Copy link
    Contributor Author

    aguspe commented May 5, 2024

    Thank you @aguspe !

    Thank you for the quick merge, have a great sunday!

    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.

    2 participants

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