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

Update documentation for Selenium 4.30.1 (rb) #15484

Merged
merged 1 commit into from
Mar 23, 2025

Conversation

selenium-ci
Copy link
Member

@selenium-ci selenium-ci commented Mar 22, 2025

User description

This PR updates the API documentation for rb language bindings to version 4.30.1.


PR Type

Documentation


Description

  • Updated API documentation for Selenium rb language bindings to version 4.30.1.

  • Added new method #script to various Selenium WebDriver classes, including Driver, Chromium, Remote, Chrome, Edge, Firefox, Safari, and IE.

  • Enhanced method details, including return types and references for #script.

  • Updated version constant in Selenium WebDriver documentation from 4.30.0 to 4.30.1.

  • Adjusted method ordering for consistency across classes.

  • Updated footer generation timestamps across all documentation files.


Changes walkthrough 📝

Relevant files
Documentation
83 files
method_list.html
Update method list for Selenium WebDriver API documentation.

docs/api/rb/method_list.html

  • Added new method entries for Selenium WebDriver classes, including
    #script, #timeouts, and others.
  • Adjusted the ordering of method entries between odd and even classes
    for consistency.
  • Updated documentation links and titles for various methods.
  • +185/-177
    Driver.html
    Add and update methods in WebDriver Driver documentation.

    docs/api/rb/Selenium/WebDriver/Driver.html

  • Added documentation for the new #script method in
    Selenium::WebDriver::Driver.
  • Updated line references for existing methods to reflect changes in the
    source file.
  • Enhanced method details with return types and references for #script.
  • +163/-82
    Driver.html
    Add `#script` method to Chromium Driver documentation.     

    docs/api/rb/Selenium/WebDriver/Chromium/Driver.html

  • Included the #script method in the inherited methods list.
  • Updated footer generation timestamp for the documentation.
  • +2/-2     
    Driver.html
    Add `#script` method to Remote Driver documentation.         

    docs/api/rb/Selenium/WebDriver/Remote/Driver.html

  • Included the #script method in the inherited methods list.
  • Updated footer generation timestamp for the documentation.
  • +2/-2     
    Driver.html
    Add `#script` method to Chrome Driver documentation.         

    docs/api/rb/Selenium/WebDriver/Chrome/Driver.html

  • Included the #script method in the inherited methods list.
  • Updated footer generation timestamp for the documentation.
  • +2/-2     
    WebDriver.html
    Update Selenium WebDriver version to 4.30.1.                         

    docs/api/rb/Selenium/WebDriver.html

  • Updated the version constant from 4.30.0 to 4.30.1.
  • Updated footer generation timestamp for the documentation.
  • +2/-2     
    V132.html
    Update footer timestamp in DevTools documentation.             

    docs/api/rb/Selenium/DevTools/V132.html

    • Updated footer generation timestamp for the documentation.
    +1/-1     
    Driver.html
    Update Edge Driver documentation with new method and timestamp.

    docs/api/rb/Selenium/WebDriver/Edge/Driver.html

  • Added a new method #script to the list of inherited methods.
  • Updated the footer's generation timestamp.
  • +2/-2     
    Driver.html
    Update Firefox Driver documentation with new method and timestamp.

    docs/api/rb/Selenium/WebDriver/Firefox/Driver.html

  • Added a new method #script to the list of inherited methods.
  • Updated the footer's generation timestamp.
  • +2/-2     
    Driver.html
    Update IE Driver documentation with new method and timestamp.

    docs/api/rb/Selenium/WebDriver/IE/Driver.html

  • Added a new method #script to the list of inherited methods.
  • Updated the footer's generation timestamp.
  • +2/-2     
    Driver.html
    Update Safari Driver documentation with new method and timestamp.

    docs/api/rb/Selenium/WebDriver/Safari/Driver.html

  • Added a new method #script to the list of inherited methods.
  • Updated the footer's generation timestamp.
  • +2/-2     
    Options.html
    Update Chrome Options documentation timestamp.                     

    docs/api/rb/Selenium/WebDriver/Chrome/Options.html

    • Updated the footer's generation timestamp.
    +1/-1     
    Profile.html
    Update Chrome Profile documentation timestamp.                     

    docs/api/rb/Selenium/WebDriver/Chrome/Profile.html

    • Updated the footer's generation timestamp.
    +1/-1     
    BrowsingContext.html
    Update BrowsingContext documentation timestamp.                   

    docs/api/rb/Selenium/WebDriver/BiDi/BrowsingContext.html

    • Updated the footer's generation timestamp.
    +1/-1     
    UrlPattern.html
    Update UrlPattern documentation timestamp.                             

    docs/api/rb/Selenium/WebDriver/BiDi/UrlPattern.html

    • Updated the footer's generation timestamp.
    +1/-1     
    FilterBy.html
    Update FilterBy documentation timestamp.                                 

    docs/api/rb/Selenium/WebDriver/BiDi/FilterBy.html

    • Updated the footer's generation timestamp.
    +1/-1     
    InterceptedItem.html
    Update InterceptedItem documentation timestamp.                   

    docs/api/rb/Selenium/WebDriver/BiDi/InterceptedItem.html

    • Updated the footer's generation timestamp.
    +1/-1     
    InterceptedResponse.html
    Update InterceptedResponse documentation timestamp.           

    docs/api/rb/Selenium/WebDriver/BiDi/InterceptedResponse.html

    • Updated the footer's generation timestamp.
    +1/-1     
    LogHandler.html
    Update LogHandler documentation timestamp.                             

    docs/api/rb/Selenium/WebDriver/BiDi/LogHandler.html

    • Updated the footer's generation timestamp.
    +1/-1     
    Options.html
    Update Chromium Options documentation timestamp.                 

    docs/api/rb/Selenium/WebDriver/Chromium/Options.html

    • Updated the footer's generation timestamp.
    +1/-1     
    Cookies.html
    Update Cookies documentation timestamp.                                   

    docs/api/rb/Selenium/WebDriver/BiDi/Cookies.html

    • Updated the footer's generation timestamp.
    +1/-1     
    Credentials.html
    Update Credentials documentation timestamp.                           

    docs/api/rb/Selenium/WebDriver/BiDi/Credentials.html

    • Updated the footer's generation timestamp.
    +1/-1     
    Headers.html
    Update Headers documentation timestamp.                                   

    docs/api/rb/Selenium/WebDriver/BiDi/Headers.html

    • Updated the footer's generation timestamp.
    +1/-1     
    InterceptedAuth.html
    Update InterceptedAuth documentation timestamp.                   

    docs/api/rb/Selenium/WebDriver/BiDi/InterceptedAuth.html

    • Updated the footer's generation timestamp.
    +1/-1     
    InterceptedRequest.html
    Update InterceptedRequest documentation timestamp.             

    docs/api/rb/Selenium/WebDriver/BiDi/InterceptedRequest.html

    • Updated the footer's generation timestamp.
    +1/-1     
    LogInspector.html
    Update LogInspector documentation timestamp.                         

    docs/api/rb/Selenium/WebDriver/BiDi/LogInspector.html

    • Updated the footer's generation timestamp.
    +1/-1     
    Network.html
    Update Network documentation timestamp.                                   

    docs/api/rb/Selenium/WebDriver/BiDi/Network.html

    • Updated the footer's generation timestamp.
    +1/-1     
    InvalidCookieDomainError.html
    Update footer timestamp in InvalidCookieDomainError documentation.

    docs/api/rb/Selenium/WebDriver/Error/InvalidCookieDomainError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    InvalidElementStateError.html
    Update footer timestamp in InvalidElementStateError documentation.

    docs/api/rb/Selenium/WebDriver/Error/InvalidElementStateError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    InvalidSessionIdError.html
    Update footer timestamp in InvalidSessionIdError documentation.

    docs/api/rb/Selenium/WebDriver/Error/InvalidSessionIdError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    NoSuchAlertError.html
    Update footer timestamp in NoSuchAlertError documentation.

    docs/api/rb/Selenium/WebDriver/Error/NoSuchAlertError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    NoSuchCookieError.html
    Update footer timestamp in NoSuchCookieError documentation.

    docs/api/rb/Selenium/WebDriver/Error/NoSuchCookieError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    NoSuchDriverError.html
    Update footer timestamp in NoSuchDriverError documentation.

    docs/api/rb/Selenium/WebDriver/Error/NoSuchDriverError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    NoSuchElementError.html
    Update footer timestamp in NoSuchElementError documentation.

    docs/api/rb/Selenium/WebDriver/Error/NoSuchElementError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    NoSuchFrameError.html
    Update footer timestamp in NoSuchFrameError documentation.

    docs/api/rb/Selenium/WebDriver/Error/NoSuchFrameError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    NoSuchWindowError.html
    Update footer timestamp in NoSuchWindowError documentation.

    docs/api/rb/Selenium/WebDriver/Error/NoSuchWindowError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    SessionNotCreatedError.html
    Update footer timestamp in SessionNotCreatedError documentation.

    docs/api/rb/Selenium/WebDriver/Error/SessionNotCreatedError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    StaleElementReferenceError.html
    Update footer timestamp in StaleElementReferenceError documentation.

    docs/api/rb/Selenium/WebDriver/Error/StaleElementReferenceError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    UnexpectedAlertOpenError.html
    Update footer timestamp in UnexpectedAlertOpenError documentation.

    docs/api/rb/Selenium/WebDriver/Error/UnexpectedAlertOpenError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Firefox.html
    Update footer timestamp in Firefox documentation.               

    docs/api/rb/Selenium/WebDriver/Firefox.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    KeyActions.html
    Update footer timestamp in KeyActions documentation.         

    docs/api/rb/Selenium/WebDriver/KeyActions.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Keys.html
    Update footer timestamp in Keys documentation.                     

    docs/api/rb/Selenium/WebDriver/Keys.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Network.html
    Update footer timestamp in Network documentation.               

    docs/api/rb/Selenium/WebDriver/Network.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    ProfileHelper.html
    Update footer timestamp in ProfileHelper documentation.   

    docs/api/rb/Selenium/WebDriver/ProfileHelper.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    SearchContext.html
    Update footer timestamp in SearchContext documentation.   

    docs/api/rb/Selenium/WebDriver/SearchContext.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    ServiceManager.html
    Update footer timestamp in ServiceManager documentation. 

    docs/api/rb/Selenium/WebDriver/ServiceManager.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    TargetLocator.html
    Update footer timestamp in TargetLocator documentation.   

    docs/api/rb/Selenium/WebDriver/TargetLocator.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Wait.html
    Update footer timestamp in Wait documentation.                     

    docs/api/rb/Selenium/WebDriver/Wait.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    WheelActions.html
    Update footer timestamp in WheelActions documentation.     

    docs/api/rb/Selenium/WebDriver/WheelActions.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Zipper.html
    Update footer timestamp in Zipper documentation.                 

    docs/api/rb/Selenium/WebDriver/Zipper.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Dimension.html
    Update footer timestamp in Dimension documentation.           

    docs/api/rb/Selenium/WebDriver/Dimension.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    InsecureCertificateError.html
    Update footer timestamp in InsecureCertificateError documentation.

    docs/api/rb/Selenium/WebDriver/Error/InsecureCertificateError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    InvalidArgumentError.html
    Update footer timestamp in InvalidArgumentError documentation.

    docs/api/rb/Selenium/WebDriver/Error/InvalidArgumentError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    InvalidSelectorError.html
    Update footer timestamp in InvalidSelectorError documentation.

    docs/api/rb/Selenium/WebDriver/Error/InvalidSelectorError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    ScriptTimeoutError.html
    Update footer timestamp in ScriptTimeoutError documentation.

    docs/api/rb/Selenium/WebDriver/Error/ScriptTimeoutError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    UnknownCommandError.html
    Update footer timestamp in UnknownCommandError documentation.

    docs/api/rb/Selenium/WebDriver/Error/UnknownCommandError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    UnknownMethodError.html
    Update footer timestamp in UnknownMethodError documentation.

    docs/api/rb/Selenium/WebDriver/Error/UnknownMethodError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    UnsupportedOperationError.html
    Update footer timestamp in UnsupportedOperationError documentation.

    docs/api/rb/Selenium/WebDriver/Error/UnsupportedOperationError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Interactions.html
    Update footer timestamp in Interactions documentation.     

    docs/api/rb/Selenium/WebDriver/Interactions.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Logs.html
    Update footer timestamp in Logs documentation.                     

    docs/api/rb/Selenium/WebDriver/Logs.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Manager.html
    Update footer timestamp in Manager documentation.               

    docs/api/rb/Selenium/WebDriver/Manager.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Navigation.html
    Update footer timestamp in Navigation documentation.         

    docs/api/rb/Selenium/WebDriver/Navigation.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Point.html
    Update footer timestamp in Point documentation.                   

    docs/api/rb/Selenium/WebDriver/Point.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Rectangle.html
    Update footer timestamp in Rectangle documentation.           

    docs/api/rb/Selenium/WebDriver/Rectangle.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Http.html
    Update footer timestamp in Remote/Http documentation.       

    docs/api/rb/Selenium/WebDriver/Remote/Http.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    JavascriptError.html
    Update footer timestamp in JavascriptError documentation.

    docs/api/rb/Selenium/WebDriver/Error/JavascriptError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    TimeoutError.html
    Update footer timestamp in TimeoutError documentation.     

    docs/api/rb/Selenium/WebDriver/Error/TimeoutError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    UnknownError.html
    Update footer timestamp in UnknownError documentation.     

    docs/api/rb/Selenium/WebDriver/Error/UnknownError.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    FedCM.html
    Update footer timestamp in FedCM documentation.                   

    docs/api/rb/Selenium/WebDriver/FedCM.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Service.html
    Update footer timestamp in Firefox/Service documentation.

    docs/api/rb/Selenium/WebDriver/Firefox/Service.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Service.html
    Update footer timestamp in IE/Service documentation.         

    docs/api/rb/Selenium/WebDriver/IE/Service.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    file.README.html
    Update footer timestamp in README documentation.                 

    docs/api/rb/file.README.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Profile.html
    Update footer timestamp in Edge/Profile documentation.     

    docs/api/rb/Selenium/WebDriver/Edge/Profile.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    IE.html
    Update footer timestamp in IE documentation.                         

    docs/api/rb/Selenium/WebDriver/IE.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Remote.html
    Update footer timestamp in Remote documentation.                 

    docs/api/rb/Selenium/WebDriver/Remote.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Support.html
    Update footer timestamp in Support documentation.               

    docs/api/rb/Selenium/WebDriver/Support.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    _index.html
    Update footer timestamp in index documentation.                   

    docs/api/rb/_index.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    index.html
    Update footer timestamp in main index documentation.         

    docs/api/rb/index.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    top-level-namespace.html
    Update footer timestamp in top-level namespace documentation.

    docs/api/rb/top-level-namespace.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    V133.html
    Update footer timestamp in DevTools V133 documentation.   

    docs/api/rb/Selenium/DevTools/V133.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    V134.html
    Update footer timestamp in DevTools V134 documentation.   

    docs/api/rb/Selenium/DevTools/V134.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Error.html
    Update footer timestamp in Server/Error documentation.     

    docs/api/rb/Selenium/Server/Error.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    DriverExtensions.html
    Update footer timestamp in DriverExtensions documentation.

    docs/api/rb/Selenium/WebDriver/DriverExtensions.html

    • Updated the footer generation timestamp to a new date and time.
    +1/-1     
    Additional files
    101 files
    Selenium.html +1/-1     
    DevTools.html +1/-1     
    Server.html +1/-1     
    ActionBuilder.html +1/-1     
    Alert.html +1/-1     
    Atoms.html +1/-1     
    BiDi.html +1/-1     
    BaseLogEntry.html +1/-1     
    ConsoleLogEntry.html +1/-1     
    GenericLogEntry.html +1/-1     
    JavascriptLogEntry.html +1/-1     
    Session.html +1/-1     
    Status.html +1/-1     
    Struct.html +1/-1     
    ChildProcess.html +1/-1     
    Chrome.html +1/-1     
    Features.html +1/-1     
    Service.html +1/-1     
    Chromium.html +1/-1     
    Features.html +1/-1     
    Profile.html +1/-1     
    Credential.html +1/-1     
    DevTools.html +1/-1     
    ConsoleEvent.html +1/-1     
    ExceptionEvent.html +1/-1     
    MutationEvent.html +1/-1     
    NetworkInterceptor.html +1/-1     
    PinnedScript.html +1/-1     
    Request.html +1/-1     
    Response.html +1/-1     
    DownloadsFiles.html +1/-1     
    FullPageScreenshot.html +1/-1     
    HasAddons.html +1/-1     
    HasApplePermissions.html +1/-1     
    HasAuthentication.html +1/-1     
    HasBiDi.html +1/-1     
    HasCDP.html +1/-1     
    HasCasting.html +1/-1     
    HasContext.html +1/-1     
    HasDebugger.html +1/-1     
    HasDevTools.html +1/-1     
    HasFedCmDialog.html +1/-1     
    HasFileDownloads.html +1/-1     
    HasLaunching.html +1/-1     
    HasLogEvents.html +1/-1     
    HasLogs.html +1/-1     
    HasNetworkConditions.html +1/-1     
    HasNetworkInterception.html +1/-1     
    HasPermissions.html +1/-1     
    HasPinnedScripts.html +1/-1     
    HasSessionId.html +1/-1     
    PrintsPage.html +1/-1     
    UploadsFiles.html +1/-1     
    DriverFinder.html +1/-1     
    Edge.html +1/-1     
    Features.html +1/-1     
    Options.html +1/-1     
    Service.html +1/-1     
    Element.html +1/-1     
    Error.html +1/-1     
    DetachedShadowRootError.html +1/-1     
    ElementClickInterceptedError.html +1/-1     
    ElementNotInteractableError.html +1/-1     
    MoveTargetOutOfBoundsError.html +1/-1     
    NoSuchShadowRootError.html +1/-1     
    ServerError.html +1/-1     
    UnableToCaptureScreenError.html +1/-1     
    UnableToSetCookieError.html +1/-1     
    WebDriverError.html +1/-1     
    Account.html +1/-1     
    Dialog.html +1/-1     
    FileReaper.html +1/-1     
    Extension.html +1/-1     
    Features.html +1/-1     
    Options.html +1/-1     
    Profile.html +1/-1     
    ProfilesIni.html +1/-1     
    Util.html +1/-1     
    Features.html +1/-1     
    Options.html +1/-1     
    InputDevice.html +1/-1     
    Interaction.html +1/-1     
    KeyInput.html +1/-1     
    TypingInteraction.html +1/-1     
    NoneInput.html +1/-1     
    Pause.html +1/-1     
    PointerCancel.html +1/-1     
    PointerEventProperties.html +1/-1     
    PointerInput.html +1/-1     
    PointerMove.html +1/-1     
    PointerPress.html +1/-1     
    Scroll.html +1/-1     
    TypingInteraction.html +1/-1     
    WheelInput.html +1/-1     
    LocalDriver.html +1/-1     
    LogEntry.html +1/-1     
    Logger.html +1/-1     
    Options.html +1/-1     
    Platform.html +1/-1     
    PointerActions.html +1/-1     
    Additional files not shown

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more 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
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @titusfortner titusfortner merged commit f0f0bc3 into gh-pages Mar 23, 2025
    1 check passed
    @titusfortner titusfortner deleted the api-docs-4.30.1-rb branch March 23, 2025 00:42
    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