Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[py] By and find_element Docstrings for IDE #14769

Draft
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

Andre-Medina
Copy link

Adding docstrings to the python code for By and Webdriver.find_element to show examples and key information when using IDE.

Description

Adding documentation to the following:

  • py/selenium/webdriver/remote/webdriver.py to WebDriver.find_element
  • py/selenium/webdriver/common/by.py to By

To generate better docstrings with examples

Motivation and Context

Found there was no documentation which led to confusion for new developers. Came from discussing in related issue #14746

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@CLAassistant
Copy link

CLAassistant commented Nov 18, 2024

CLA assistant check
All committers have signed the CLA.

@shbenzer
Copy link
Contributor

You can refer to this page for examples

@shbenzer
Copy link
Contributor

Also once you've finished, run ./scripts/format.sh to help with linting

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.

3 participants