Skip to content

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

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
merged 4 commits into from
Jul 9, 2024

Conversation

reply2sagar
Copy link
Contributor

@reply2sagar reply2sagar commented Jun 23, 2024

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

  • 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

  • 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

Copy link

netlify bot commented Jun 23, 2024

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 7ebbae6

@qodo-merge-pro qodo-merge-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels Jun 23, 2024
Copy link
Contributor

PR Reviewer Guide 🔍

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

Copy link
Contributor

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

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.

HI @reply2sagar ,

Thank you for the PR.

Could you please apply similar changes to the pages translated into languages other than English.

@harsha509
Copy link
Member

I have updated other files with commit 9a5225c!

Thank you for the PR @reply2sagar !

@harsha509 harsha509 merged commit 728f851 into SeleniumHQ:trunk Jul 9, 2024
3 checks passed
@harsha509
Copy link
Member

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

selenium-ci added a commit that referenced this pull request Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Review effort [1-5]: 1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants