SeleniumHQ / seleniumhq.github.io

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

Local driver example of ruby was not linked with correct line number #1778

Closed reply2sagar closed 1 week ago

reply2sagar commented 3 weeks ago

User description

Description

As you can see on this page - Drivers, Under Local driver section, ruby example is showing blank line. I have added correct line in the code file. So now it is showing correct code line.

Motivation and Context

Documentation was misleading for ruby example.

Types of changes

Checklist


PR Type

Documentation


Description


Changes walkthrough ๐Ÿ“

Relevant files
Documentation
_index.en.md
Fix Ruby example code block line number in documentation 

website_and_docs/content/documentation/webdriver/drivers/_index.en.md - Corrected the line number in the Ruby example code block.
+1/-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 3 weeks ago

Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
Latest commit 7ebbae67bafb72e176d11e043c6f4529f5d7951d
codiumai-pr-agent-pro[bot] commented 3 weeks ago

PR Reviewer Guide ๐Ÿ”

โฑ๏ธ Estimated effort to review [1-5] 1
๐Ÿงช Relevant tests No
๐Ÿ”’ Security concerns No
โšก Key issues to review None
codiumai-pr-agent-pro[bot] commented 3 weeks ago

PR Code Suggestions โœจ

CategorySuggestion                                                                                                                                    Score
Possible issue
Verify that the updated line number in the Ruby example file is correct ___ **Ensure that the line number L14 in the Ruby example file options_spec.rb is correct and
points to the intended code snippet. Verify that the change from L13 to L14 accurately
reflects the correct line of code to be displayed.** [website_and_docs/content/documentation/webdriver/drivers/_index.en.md [39]](https://github.com/SeleniumHQ/seleniumhq.github.io/pull/1778/files#diff-10ff84d69cea7383c29ebfd0e4934cda8a3d6111bfc937897b1f446c4f4781b5R39-R39) ```diff +{{< gh-codeblock path="examples/ruby/spec/drivers/options_spec.rb#L14" >}} - ``` - [ ] **Apply this suggestion**
Suggestion importance[1-10]: 7 Why: The suggestion is relevant as it addresses the update of the line number in the Ruby example, ensuring it points to the correct code snippet. This is important for documentation accuracy but not a major bug or security issue.
7
harsha509 commented 1 week ago

I have updated other files with commit https://github.com/SeleniumHQ/seleniumhq.github.io/commit/9a5225c03a1e60c1e6253084c4f5510c6d4e81de!

Thank you for the PR @reply2sagar !

harsha509 commented 1 week ago

congratulations on your first contribution to Selenium-Docs @reply2sagar ๐ŸŽ‰ ๐ŸŽ‰