Skip to content
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

[rb] Update note for return value of Hash #14845

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Conversation

luke-hill
Copy link
Contributor

@luke-hill luke-hill commented Dec 3, 2024

User description

Thanks for contributing to Selenium!
A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.

Description

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

PR Type

documentation


Description

  • Updated the documentation for the cookie_named method in the Selenium WebDriver Ruby library.
  • Clarified that the method returns a Hash and throws a NoSuchCookieError if the cookie is not found.

Changes walkthrough 📝

Relevant files
Documentation
manager.rb
Update return type documentation for `cookie_named` method

rb/lib/selenium/webdriver/common/manager.rb

  • Updated the return type documentation for the cookie_named method.
  • Changed the return type from [Hash, nil] to [Hash].
  • +1/-1     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @luke-hill luke-hill merged commit ce7448b into trunk Dec 3, 2024
    @luke-hill luke-hill deleted the refactor/rb-cookie-notes branch December 3, 2024 08:46
    Copy link
    Contributor

    qodo-merge-pro bot commented Dec 3, 2024

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Accuracy
    The updated documentation removes the 'nil' from the return type, but it should be verified if the method can actually never return nil. The implementation should be checked to confirm this change is accurate.

    Copy link
    Contributor

    qodo-merge-pro bot commented Dec 3, 2024

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    sandeepsuryaprasad pushed a commit to sandeepsuryaprasad/selenium that referenced this pull request Dec 3, 2024
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant