Skip to content

[py] Update API docs - include nightly release and other minor fixes#16132

Merged
cgoldberg merged 1 commit intoSeleniumHQ:trunkfrom
cgoldberg:py-update-readme
Aug 5, 2025
Merged

[py] Update API docs - include nightly release and other minor fixes#16132
cgoldberg merged 1 commit intoSeleniumHQ:trunkfrom
cgoldberg:py-update-readme

Conversation

@cgoldberg
Copy link
Copy Markdown
Member

@cgoldberg cgoldberg commented Aug 5, 2025 •
edited by qodo-code-review bot
Loading

User description

💥 What does this PR do?

This PR updates index.rst in the Python API docs (which is also our package README):

  • include instructions for installing nightly development version
  • remove outdated mentions of tools (black, flake8, isort)
  • minor formatting

🔄 Types of changes

  • Cleanup (formatting, renaming)

PR Type

Documentation

Description

  • Add nightly development release installation instructions

  • Remove outdated tool references (black, flake8, isort)

  • Improve formatting and text clarity

  • Update contributing guidelines

Diagram Walkthrough

flowchart LR
  A["Python API docs"] --> B["Add nightly install"]
  A --> C["Remove outdated tools"]
  A --> D["Format improvements"]
  A --> E["Update contributing"]
Loading

File Walkthrough
Relevant files
Documentation
index.rst
Update Python documentation with nightly install                 

py/docs/source/index.rst

  • Add nightly development release installation instructions
  • Remove references to outdated tools (black, flake8, isort)
  • Improve text formatting and line breaks
  • Update contributing section with cleaner instructions
 +27/-20 

@selenium-ci selenium-ci added the C-py Python Bindings label Aug 5, 2025
@qodo-code-review
Copy link
Copy Markdown
Contributor

qodo-code-review bot commented Aug 5, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

Nightly URL

The nightly development release installation command uses test.pypi.org which may not be the intended source for nightly builds. Verify this is the correct URL for Selenium nightly releases.

 
pip install -U --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ selenium

@qodo-code-review
Copy link
Copy Markdown
Contributor

qodo-code-review bot commented Aug 5, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Add warning for nightly releases

The nightly installation command may fail if the package doesn't exist on
test.pypi.org or has dependency conflicts. Consider adding a warning about
potential instability and fallback instructions.

py/docs/source/index.rst [56-58]

-Nightly development release::
+Nightly development release (unstable, for testing only)::
 
     pip install -U --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ selenium
 
+.. warning::
+   Nightly releases are unstable and may contain bugs. Use only for testing purposes.
+
  • Apply / Chat
Suggestion importance[1-10]: 6

__

Why: The suggestion correctly points out that nightly releases can be unstable and proposes adding a warning, which is a good practice for managing user expectations and improving documentation clarity.

Low
  • More

@cgoldberg cgoldberg merged commit cc88b00 into SeleniumHQ:trunk Aug 5, 2025
12 checks passed
@cgoldberg cgoldberg deleted the py-update-readme branch August 5, 2025 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

C-py Python Bindings Review effort 2/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cgoldberg @selenium-ci