Skip to content

[py] Add missing modules to python API docs #15779

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 1 commit into from
May 23, 2025

Conversation

cgoldberg
Copy link
Contributor

@cgoldberg cgoldberg commented May 23, 2025

User description

💥 What does this PR do?

This PR adds the following modules to py/docs/source/api.rst:

  • selenium.webdriver.common.bidi.browsing_context
  • selenium.webdriver.common.bidi.log
  • selenium.webdriver.common.bidi.storage

Since they were missing, their documentation was not getting generated in the Python API docs.

💡 Additional Considerations

Note to maintainers: Any time a new Python file/module is added, a new entry must be added to py/docs/source/api.rst in order for the module's docstrings to get generated into documentation pages.

🔄 Types of changes

  • Bug fix (backwards compatible)
  • Documentation

PR Type

Documentation, Bug fix


Description

  • Add missing BiDi modules to Python API docs

  • Ensure documentation generation for new modules

  • Improve completeness of API reference documentation


Changes walkthrough 📝

Relevant files
Documentation
api.rst
Add missing BiDi modules to API documentation index           

py/docs/source/api.rst

  • Added browsing_context, log, and storage BiDi modules to API docs
  • Ensured new modules are included in documentation generation
  • +3/-0     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • @selenium-ci selenium-ci added C-py Python Bindings and removed Review effort 1/5 labels May 23, 2025
    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.

    @cgoldberg cgoldberg merged commit 92db47f into SeleniumHQ:trunk May 23, 2025
    7 checks passed
    @cgoldberg cgoldberg deleted the py-add-missing-docs-modules branch May 23, 2025 02:12
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    C-py Python Bindings
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants