seleniumhq.github.io icon indicating copy to clipboard operation
seleniumhq.github.io copied to clipboard

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

Open reply2sagar opened this issue 1 year ago • 3 comments

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

  • [x] 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

  • [x] I have read the contributing document.
  • [x] I have used hugo to render the site/docs locally and I am sure it works.

PR Type

Documentation


Description

  • Corrected the line number in the Ruby example code block under the Local driver section in the documentation.
  • Ensured the Ruby example is now displayed correctly on the Selenium documentation site.

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

reply2sagar avatar Jun 23 '24 11:06 reply2sagar

Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
Latest commit 7ebbae67bafb72e176d11e043c6f4529f5d7951d

netlify[bot] avatar Jun 23 '24 11:06 netlify[bot]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5] 1
🧪 Relevant tests No
🔒 Security concerns No
⚡ Key issues to review None

qodo-merge-pro[bot] avatar Jun 23 '24 11:06 qodo-merge-pro[bot]

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]

+{{< 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

qodo-merge-pro[bot] avatar Jun 23 '24 11:06 qodo-merge-pro[bot]

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

Thank you for the PR @reply2sagar !

harsha509 avatar Jul 09 '24 09:07 harsha509

congratulations on your first contribution to Selenium-Docs @reply2sagar 🎉 🎉

harsha509 avatar Jul 09 '24 09:07 harsha509