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

chore: Update docstrings in presto.py #17623

Merged
merged 1 commit into from
Dec 2, 2021
Merged

chore: Update docstrings in presto.py #17623

merged 1 commit into from
Dec 2, 2021

Conversation

PApostol
Copy link
Contributor

@PApostol PApostol commented Dec 1, 2021

Update some docstrings in superset/db_engine_specs/presto.py to match the input arguments.

SUMMARY

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@codecov
Copy link

codecov bot commented Dec 1, 2021

Codecov Report

Merging #17623 (24912cc) into master (0544bee) will decrease coverage by 0.18%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #17623      +/-   ##
==========================================
- Coverage   68.55%   68.36%   -0.19%     
==========================================
  Files        1601     1601              
  Lines       65271    65271              
  Branches     6966     6966              
==========================================
- Hits        44745    44624     -121     
- Misses      18636    18757     +121     
  Partials     1890     1890              
Flag Coverage Δ
hive ?
mysql 81.80% <ø> (ø)
postgres 81.81% <ø> (ø)
presto ?
python 81.89% <ø> (-0.41%) ⬇️
sqlite 81.49% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
superset/db_engine_specs/presto.py 83.50% <ø> (-6.89%) ⬇️
superset/db_engines/hive.py 0.00% <0.00%> (-85.19%) ⬇️
superset/db_engine_specs/hive.py 70.27% <0.00%> (-16.99%) ⬇️
superset/views/database/mixins.py 81.03% <0.00%> (-1.73%) ⬇️
superset/connectors/sqla/models.py 86.85% <0.00%> (-1.58%) ⬇️
superset/models/core.py 89.26% <0.00%> (-0.74%) ⬇️
superset/db_engine_specs/base.py 88.15% <0.00%> (-0.39%) ⬇️
superset/utils/core.py 89.64% <0.00%> (-0.12%) ⬇️

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 0544bee...24912cc. Read the comment docs.

Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for the cleanup!

@villebro villebro merged commit ce92fc1 into apache:master Dec 2, 2021
@john-bodley
Copy link
Member

@PApostol and @villebro beyond this change theres a cool PyLint extension docparams which ensures that params, returns, and exceptions are documented correctly.

We use it on a number of projects at Airbnb and it's a great way to ensuring that functions are well documented and that the documentation is up to date. Without doubt the introduction of Mypy has removed some need for doc-strings however because: i) (sadly) Mypy doesn't handle exception typing, and ii) variable names may not contain sufficient detail, I sense there is still merit in having doc-params.

@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 1.5.0 labels Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XS 🚢 1.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants