Skip to content

Conversation

pallavigitwork
Copy link
Member

@pallavigitwork pallavigitwork commented Sep 5, 2025

User description

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Partial Fixes Bug #2446 . zh-cn file is remaining, as not aware of language

Description

Bug 2446 raises concern to change text from editable to keyboard interactable, as mentioned in the W3C
document of SendKeys.
Link -https://w3c.github.io/webdriver/#dfn-keyboard-interactable

Motivation and Context

To fix the bug raised.

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

PR Type

Documentation


Description

  • Update terminology from "editable" to "keyboard interactable"

  • Align documentation with W3C WebDriver specification

  • Apply changes across multiple language versions


Diagram Walkthrough

flowchart LR
  A["Documentation Files"] --> B["Replace 'editable'"] 
  B --> C["'keyboard interactable'"]
  C --> D["W3C Compliance"]
Loading

File Walkthrough

Relevant files
Documentation
interactions.en.md
Update terminology in English documentation                           

website_and_docs/content/documentation/webdriver/elements/interactions.en.md

  • Replace "editable" with "keyboard interactable" in send keys
    description
  • Update both bullet point and detailed section text
+2/-2     
interactions.ja.md
Update terminology in Japanese documentation                         

website_and_docs/content/documentation/webdriver/elements/interactions.ja.md

  • Replace "editable" with "keyboard interactable" in send keys
    description
  • Update both bullet point and detailed section text
+2/-2     
interactions.pt-br.md
Update terminology in Portuguese documentation                     

website_and_docs/content/documentation/webdriver/elements/interactions.pt-br.md

  • Replace "editable" with "keyboard interactable" in send keys
    description
  • Update both bullet point and detailed section text
+2/-2     

Copy link

netlify bot commented Sep 5, 2025

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 7536788

@pallavigitwork pallavigitwork requested a review from a team September 5, 2025 11:40
Copy link
Contributor

qodo-merge-pro bot commented Sep 5, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

2446 - Partially compliant

Compliant requirements:

  • Update the Send Keys documentation to clarify that the target element must be keyboard-interactable, not merely editable.
  • Align wording with the W3C WebDriver spec for Element Send Keys.
  • Apply changes across documentation pages/languages where relevant.

Non-compliant requirements:

  • Verify applicability beyond editable elements (e.g., buttons) per spec language.

Requires further human verification:

  • Confirm zh-cn (and other locales if applicable) are updated or explicitly tracked for follow-up.
  • Validate that the resulting language accurately reflects spec behavior across drivers/browsers (manual spot-check).
⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Terminology Accuracy

The updated paragraph still mentions "If it is not editable..." which may conflict with the new "keyboard interactable" criteria; consider updating the error condition wording to reference keyboard-interactable or element not interactable per spec.

The [element send keys command](https://w3c.github.io/webdriver/#dfn-element-send-keys) 
types the provided keys into an [keyboard interactable](https://w3c.github.io/webdriver/#dfn-keyboard-interactable) element.
Typically, this means an element is an input element of a form with a `text` type or an element
with a `content-editable` attribute. If it is not editable,
[an invalid element state](https://w3c.github.io/webdriver/#dfn-invalid-element-state) error is returned.
Link Consistency

The "clear" bullet still says "content editable elements" and links to element-send-keys; consider verifying link and terminology for Clear per spec to avoid confusion alongside the updated send keys description.

* [clear](https://w3c.github.io/webdriver/#element-send-keys) (only applies to text fields and content editable elements)
* submit (only applies to form elements)
Grammar

The phrase "an keyboard interactable element" is grammatically incorrect in English text segments; use "a keyboard-interactable element" and ensure consistency across locales.

The [element send keys command](https://w3c.github.io/webdriver/#dfn-element-send-keys)
types the provided keys into an [keyboard interactable](https://w3c.github.io/webdriver/#dfn-keyboard-interactable) element.
Typically, this means an element is an input element of a form with a `text` type or an element
with a `content-editable` attribute. If it is not editable,
[an invalid element state](https://w3c.github.io/webdriver/#dfn-invalid-element-state) error is returned.

Copy link
Contributor

qodo-merge-pro bot commented Sep 5, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix article and hyphenation

Use the correct article and hyphenation for the spec term. Change "an keyboard
interactable" to "a keyboard-interactable" to fix grammar and match the
WebDriver terminology.

website_and_docs/content/documentation/webdriver/elements/interactions.en.md [79]

-types the provided keys into an [keyboard interactable](https://w3c.github.io/webdriver/#dfn-keyboard-interactable) element.
+types the provided keys into a [keyboard-interactable](https://w3c.github.io/webdriver/#dfn-keyboard-interactable) element.
  • Apply / Chat
Suggestion importance[1-10]: 5

__

Why: The suggestion correctly identifies a grammatical error (an instead of a) and aligns the terminology (keyboard-interactable) with the official WebDriver specification, improving the documentation's correctness.

Low
  • Update

@pallavigitwork pallavigitwork merged commit 5e333fc into SeleniumHQ:trunk Sep 6, 2025
3 checks passed
@pallavigitwork pallavigitwork deleted the Fix2446 branch September 8, 2025 11:39
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