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

[py] remove deprecated parameter from EdgeService #14563

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

Delta456
Copy link
Contributor

@Delta456 Delta456 commented Oct 4, 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

Remove verbose parameter from EdgeService documentation because verbose is no longer a parameter

Motivation and Context

It solves the redundant comment documentation which is there and confuses it was still meant to be there.

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

  • Removed the deprecated verbose parameter from the EdgeService class documentation to prevent confusion, as it is no longer a valid parameter.

Changes walkthrough 📝

Relevant files
Documentation
service.py
Remove deprecated `verbose` parameter from EdgeService documentation

py/selenium/webdriver/edge/service.py

  • Removed the deprecated verbose parameter from the EdgeService class
    documentation.
  • +0/-2     

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

    Copy link
    Contributor

    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 Update
    The PR removes the deprecated verbose parameter from the EdgeService class documentation. This change is appropriate and aligns with the removal of the parameter from the actual implementation.

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Documentation
    Update the class docstring to reflect the removal of a deprecated parameter

    Consider updating the class docstring to reflect the removal of the verbose
    parameter. This will ensure that the documentation accurately represents the current
    state of the EdgeService class.

    py/selenium/webdriver/edge/service.py [23-33]

     class Service(service.ChromiumService):
         """A Service class that is responsible for the starting and stopping of
         `msedgedriver`.
     
         :param executable_path: install path of the msedgedriver executable, defaults to `msedgedriver`.
         :param port: Port for the service to run on, defaults to 0 where the operating system will decide.
         :param log_output: (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file.
         :param service_args: (Optional) List of args to be passed to the subprocess when launching the executable.
         :param env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
    +    
    +    Note: The `verbose` parameter has been deprecated and removed.
         """
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: The suggestion accurately proposes updating the class docstring to mention the removal of the deprecated verbose parameter, which is important for maintaining accurate and up-to-date documentation. This enhances clarity for future developers and users of the class.

    8

    💡 Need additional feedback ? start a PR chat

    @harsha509 harsha509 merged commit 7a27fe7 into SeleniumHQ:trunk Oct 4, 2024
    12 of 13 checks passed
    @Delta456 Delta456 deleted the edge_service branch November 6, 2024 10:30
    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.

    2 participants