Skip to content

[py] docs: updated api docs#10622

Merged
titusfortner merged 5 commits intoSeleniumHQ:trunkfrom
SinghHrmn:fix-python-api-docs
May 10, 2022
Merged

[py] docs: updated api docs#10622
titusfortner merged 5 commits intoSeleniumHQ:trunkfrom
SinghHrmn:fix-python-api-docs

Conversation

@SinghHrmn
Copy link
Copy Markdown
Contributor

@SinghHrmn SinghHrmn commented May 9, 2022

skip ci

Description

fixes: #10571

Motivation and Context

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.

@@ -0,0 +1,29 @@
selenium.webdriver.firefox.remote\_connection
Copy link
Copy Markdown
Member

@symonk symonk May 9, 2022

Choose a reason for hiding this comment

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

intentional \ ? (quite a lot cases of this)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

that's how all the docs are right now. probably just a sphinx thing?

Copy link
Copy Markdown

@ollie-iterators ollie-iterators left a comment

Choose a reason for hiding this comment

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

  • "selenium.webdriver.common.actions.key_actios" should be "selenium.webdriver.common.actions.key_actions"
  • "selenium.webdriver.support.realtive_locator" should be "selenium.webdriver.support.relative_locator"

@titusfortner titusfortner added C-py Python Bindings B-docs API Docs; see other repo for website documentation labels May 9, 2022
@SinghHrmn SinghHrmn force-pushed the fix-python-api-docs branch from eff4229 to 7f5468b Compare May 10, 2022 08:33
@SinghHrmn SinghHrmn marked this pull request as ready for review May 10, 2022 08:34
@titusfortner titusfortner added this to the 4.2 milestone May 10, 2022
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 10, 2022

Codecov Report

Merging #10622 (1e7f08b) into trunk (780ae58) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##            trunk   #10622      +/-   ##
==========================================
- Coverage   45.61%   45.60%   -0.02%     
==========================================
  Files          86       86              
  Lines        5724     5730       +6     
  Branches      274      274              
==========================================
+ Hits         2611     2613       +2     
- Misses       2839     2843       +4     
  Partials      274      274              
Impacted Files Coverage Δ
py/selenium/webdriver/opera/options.py 31.11% <0.00%> (+0.15%) ⬆️
py/selenium/webdriver/opera/webdriver.py 22.22% <0.00%> (+1.01%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 780ae58...1e7f08b. Read the comment docs.

@titusfortner titusfortner merged commit c367a5a into SeleniumHQ:trunk May 10, 2022
elgatov pushed a commit to elgatov/selenium that referenced this pull request Jun 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

B-docs API Docs; see other repo for website documentation C-py Python Bindings

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

[🐛 Bug]: Webdriver.firefox API documentation incomplete

5 participants