Skip to content

implement warnings section for internal BiDi reference#2659

Open
titusfortner wants to merge 2 commits into
trunkfrom
bidi_warning
Open

implement warnings section for internal BiDi reference#2659
titusfortner wants to merge 2 commits into
trunkfrom
bidi_warning

Conversation

@titusfortner
Copy link
Copy Markdown
Member

Implements the documentation piece of: SeleniumHQ/selenium#17628

To describe why things are marked internal.

@qodo-code-review
Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Add warnings documentation for internal BiDi APIs

📝 Documentation

Grey Divider

Walkthroughs

Description
• Adds warnings documentation section explaining internal APIs
• Documents BiDi implementation API internal marking rationale
• Provides guidance on using high-level BiDi APIs instead
• Includes issue reporting instructions for uncovered use cases
Diagram
flowchart LR
  A["Warnings Section"] --> B["BiDi Implementation Guide"]
  B --> C["Explains Internal Marking"]
  C --> D["Recommends High-Level APIs"]
  D --> E["Issue Reporting Link"]

Loading

Grey Divider

File Changes

1. website_and_docs/content/documentation/warnings/_index.en.md 📝 Documentation +10/-0

Create warnings documentation index page

• Creates new warnings documentation index page
• Defines section title, link title, and weight for navigation
• Provides overview explaining IDE/compiler warnings in Selenium

website_and_docs/content/documentation/warnings/_index.en.md


2. website_and_docs/content/documentation/warnings/bidi-implementation.en.md 📝 Documentation +38/-0

Document BiDi internal API marking and alternatives

• Documents why BiDi implementation APIs are marked internal
• Lists internal BiDi namespaces across Java, .NET, Python, Ruby
• Explains internal marking as steering toward high-level APIs
• Recommends using high-level network and script BiDi APIs
• Includes link to open GitHub issues for uncovered use cases

website_and_docs/content/documentation/warnings/bidi-implementation.en.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link
Copy Markdown
Contributor

qodo-code-review Bot commented Jun 4, 2026

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 4, 2026

Deploy Preview for selenium-dev ready!

Name Link
🔨 Latest commit c91ff9f
🔍 Latest deploy log https://app.netlify.com/projects/selenium-dev/deploys/6a22ba5213aec20008b40143
😎 Deploy Preview https://deploy-preview-2659--selenium-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants