Skip to content

Conversation

@Aidoni0797
Copy link
Contributor

@Aidoni0797 Aidoni0797 commented Aug 15, 2025

User description

Improved wording in the docstring and added a clarification comment in keys.py.
No functional changes, only documentation updates.


PR Type

Documentation


Description

  • Updated class docstring for better clarity

  • Improved comment for numpad keys section


File Walkthrough

Relevant files
Documentation
keys.py
Documentation improvements for Keys class                               

py/selenium/webdriver/common/keys.py

  • Updated class docstring from "Set of special keys codes" to "Set of
    special key codes for keyboard actions"
  • Enhanced comment for NUMPAD0 from "number pad keys" to "Keys
    representing number pad digits"
+2/-2     

Improve wording in docstring and comment in keys.py
@CLAassistant
Copy link

CLAassistant commented Aug 15, 2025

CLA assistant check
All committers have signed the CLA.

@selenium-ci selenium-ci added the C-py Python Bindings label Aug 15, 2025
@qodo-merge-pro
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
⚡ Recommended focus areas for review

Wording Accuracy

The docstring "Set of special key codes for keyboard actions" may imply only keyboard usage; confirm consistency with any non-keyboard contexts (if any) where Keys constants are used (e.g., action chains or IME). Ensure wording aligns with broader usage across the project.

"""Set of special key codes for keyboard actions."""
Comment Clarity

The comment on NUMPAD0 says "Keys representing number pad digits" but is attached only to NUMPAD0. Consider clarifying whether it applies to NUMPAD0-9 or rephrasing to avoid implying a range from a single line comment.

NUMPAD0 = "\ue01a"  # Keys representing number pad digits.
NUMPAD1 = "\ue01b"

@qodo-merge-pro
Copy link
Contributor

qodo-merge-pro bot commented Aug 15, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

Aidoni0797 and others added 2 commits August 15, 2025 21:17
Refine docstring and clarify NUMPAD comment as per review feedback
@cgoldberg cgoldberg changed the title Update docstring and comment in keys.py [py] Update docstring and comments in keys.py Aug 15, 2025
Copy link
Member

@cgoldberg cgoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a commit to your branch with some minor formatting changes to make it compliant with PEP257 and to make sure our linter doesn't freak out.

Thanks for your first contribution to Selenium!

@cgoldberg cgoldberg merged commit 706495a into SeleniumHQ:trunk Aug 15, 2025
1 check passed
This was referenced Oct 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants