[py] Update docstrings (remove reST leftovers and resolve D200) by iampopovich · Pull Request #16525 · SeleniumHQ/selenium

iampopovich · 2025-10-28T20:51:34Z

User description

🔗 Related Issues

relates to #16432

💥 What does this PR do?

This pull request makes minor improvements to code documentation throughout several modules. The main change is the standardization of docstring formatting for class and method documentation, improving readability and consistency.

Documentation standardization:

Reformatted class-level docstrings in the BiDi modules (browser.py, input.py, permissions.py, webextension.py) to single-line style for better clarity and consistency. [1] [2] [3] [4]
Updated method docstrings in firefox/options.py to use multi-line format with explicit return value descriptions, making documentation more readable. [1] [2] [3]
Changed method docstrings in print_page_options.py and script.py to improve formatting and clarity. [1] [2]

🔧 Implementation Notes

i've added D200 rule locally and fixed all warns with no changes in rules in the main repo

💡 Additional Considerations

🔄 Types of changes

Cleanup (formatting, renaming)

PR Type

Documentation

Description

Standardize docstring formatting to single-line style
Convert multi-line docstrings to PEP 257 compliant format
Resolve D200 ruff linting warnings across BiDi modules
Improve docstring consistency in Firefox and print options

Diagram Walkthrough

flowchart LR
  A["Multi-line docstrings"] -->|Convert to single-line| B["BiDi modules"]
  C["Malformed return docs"] -->|Reformat to PEP 257| D["Firefox & Print options"]
  B --> E["D200 compliance"]
  D --> E

File Walkthrough

Relevant files

Documentation

browser.py `Standardize Browser class docstring format` py/selenium/webdriver/common/bidi/browser.py Converted multi-line class docstring to single-line format Improved readability of Browser class documentation	+1/-3
input.py `Standardize Input class docstring format` py/selenium/webdriver/common/bidi/input.py Converted multi-line class docstring to single-line format Enhanced Input class documentation consistency	+1/-3
permissions.py `Standardize Permissions class docstring format` py/selenium/webdriver/common/bidi/permissions.py Converted multi-line class docstring to single-line format Improved Permissions class documentation clarity	+1/-3
script.py `Standardize script conversion method docstring` py/selenium/webdriver/common/bidi/script.py Converted multi-line method docstring to single-line format Standardized __convert_to_local_value method documentation	+1/-3
webextension.py `Standardize WebExtension class docstring format` py/selenium/webdriver/common/bidi/webextension.py Converted multi-line class docstring to single-line format Enhanced WebExtension class documentation consistency	+1/-3
print_page_options.py `Reformat print options docstring to PEP 257` py/selenium/webdriver/common/print_page_options.py Reformatted to_dict method docstring from inline to multi-line format Added explicit Returns section for better PEP 257 compliance	+4/-1
options.py `Reformat Firefox options docstrings to PEP 257` py/selenium/webdriver/firefox/options.py Reformatted binary_location property docstring to multi-line format Reformatted preferences property docstring to multi-line format Reformatted profile property docstring to multi-line format Added explicit Returns sections for all three properties	+12/-3

qodo-code-review · 2025-10-28T20:52:04Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed
⚪	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Error context: The raised WebDriverException may represent a critical action outcome without any explicit logging added in this PR. Referred Code raise WebDriverException(error_message)
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

iampopovich · 2025-10-28T20:52:20Z

@cgoldberg please review 🙏

qodo-code-review · 2025-10-28T20:52:56Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Learned best practice	Specify to_dict return details Make the docstring explicit about the returned structure and its mutability to avoid ambiguity and align with user expectations. py/selenium/webdriver/common/print_page_options.py [337-342] def to_dict(self) -> _PrintOpts: """ + Get the current print configuration. + Returns: - A hash of print options configured. + _PrintOpts: A dictionary of the configured print options; this is the internal dict and may be mutated by callers. """ return self._print_options Apply / Chat Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Keep API and documentation accurate and consistent by using precise, informative docstrings that describe behavior and types rather than generic placeholders.	Low
Update

navin772

LGTM!

cgoldberg

LGTM. thanks.

Refactor docstrings in BiDi classes for consistency and clarity

0704515

selenium-ci added C-py Python Bindings B-devtools Includes everything BiDi or Chrome DevTools related labels Oct 28, 2025

qodo-code-review bot added the Review effort 1/5 label Oct 28, 2025

iampopovich changed the title ~~remove reST leftovers and resolve D200 ruff warns~~ [py] remove reST leftovers and resolve D200 ruff warns Oct 28, 2025

navin772 approved these changes Oct 29, 2025

View reviewed changes

Merge branch 'trunk' into feat/reST-leftovers-cleanup

e77fb3f

cgoldberg changed the title ~~[py] remove reST leftovers and resolve D200 ruff warns~~ [py] Update docstrings (remove reST leftovers and resolve D200) Oct 29, 2025

cgoldberg approved these changes Oct 29, 2025

View reviewed changes

cgoldberg merged commit 2bc81b8 into SeleniumHQ:trunk Oct 29, 2025
22 checks passed

This was referenced Dec 22, 2025

Bump the functionaltests group with 6 updates israurreacarballo/DORA#316

Closed

chore(deps): nuget update: Bump Selenium.WebDriver from 4.34.0 to 4.39.0 BySuspect/AutoPixAiCreditClaimer#40

Closed

dependabot bot mentioned this pull request Feb 11, 2026

chore: Bump Selenium.WebDriver from 4.36.0 to 4.40.0 appium/dotnet-client#1008

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[py] Update docstrings (remove reST leftovers and resolve D200)#16525

[py] Update docstrings (remove reST leftovers and resolve D200)#16525
cgoldberg merged 2 commits intoSeleniumHQ:trunkfrom
iampopovich:feat/reST-leftovers-cleanup

iampopovich commented Oct 28, 2025 •

edited by qodo-code-review bot

Loading

Uh oh!

qodo-code-review bot commented Oct 28, 2025 •

edited

Loading

Uh oh!

iampopovich commented Oct 28, 2025

Uh oh!

qodo-code-review bot commented Oct 28, 2025 •

edited

Loading

Uh oh!

navin772 left a comment

Uh oh!

cgoldberg left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

iampopovich commented Oct 28, 2025 • edited by qodo-code-review bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

🔗 Related Issues

💥 What does this PR do?

🔧 Implementation Notes

💡 Additional Considerations

🔄 Types of changes

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

qodo-code-review bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Compliance Guide 🔍

Uh oh!

iampopovich commented Oct 28, 2025

Uh oh!

qodo-code-review bot commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Uh oh!

navin772 left a comment

Choose a reason for hiding this comment

Uh oh!

cgoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iampopovich commented Oct 28, 2025 •

edited by qodo-code-review bot

Loading

qodo-code-review bot commented Oct 28, 2025 •

edited

Loading

qodo-code-review bot commented Oct 28, 2025 •

edited

Loading