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

Cleanup docstrings, fix broken formatting #10838

Merged
merged 1 commit into from
Jul 6, 2022
Merged

Cleanup docstrings, fix broken formatting #10838

merged 1 commit into from
Jul 6, 2022

Conversation

jsfehler
Copy link
Contributor

@jsfehler jsfehler commented Jul 3, 2022

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

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

Description

Tweak the docstrings in webdriver/common/log.py to standardize their style and fix broken formatting.

Motivation and Context

The documentation now formats the docstrings correctly.

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.

@codecov-commenter
Copy link

Codecov Report

Merging #10838 (04586ee) into trunk (2fbfc62) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##            trunk   #10838      +/-   ##
==========================================
- Coverage   50.46%   50.45%   -0.01%     
==========================================
  Files          84       84              
  Lines        5477     5480       +3     
  Branches      278      278              
==========================================
+ Hits         2764     2765       +1     
- Misses       2435     2437       +2     
  Partials      278      278              
Impacted Files Coverage Δ
py/selenium/webdriver/common/log.py 29.57% <ø> (ø)
py/selenium/webdriver/firefox/firefox_binary.py 32.59% <0.00%> (+0.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 2fbfc62...04586ee. Read the comment docs.

@titusfortner titusfortner requested a review from symonk July 5, 2022 13:55
@AutomatedTester AutomatedTester merged commit 09e296c into SeleniumHQ:trunk Jul 6, 2022
@jsfehler jsfehler deleted the log_docstring branch July 6, 2022 12:35
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