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

docs: Enable Linting of docstrings #3506

Merged
merged 10 commits into from
Dec 6, 2024
Merged

docs: Enable Linting of docstrings #3506

merged 10 commits into from
Dec 6, 2024

Conversation

samster25
Copy link
Member

@samster25 samster25 commented Dec 6, 2024

Enables the following:

  "RUF010",  # Use explicit conversion flag
  "RUF013",  # PEP 484 prohibits implicit Optional
  "RUF015",  # Prefer next({iterable}) over single element slice
  "RUF017",  # Avoid quadratic list summation
  "RUF022",  # __all__ is not sorted
  "RUF032",  # Decimal() called with float literal argument
  "RUF034",  # Useless if-else condition
  "RUF041",  # Unnecessary nested Literal
  "RUF100",  # unused-noqa"
  "D"  # pydocstyle rules

As well as code block linting within a docstring. Like the case with Examples.

@github-actions github-actions bot added the docs label Dec 6, 2024
Copy link

codspeed-hq bot commented Dec 6, 2024

CodSpeed Performance Report

Merging #3506 will degrade performances by 12.16%

Comparing sammy/docstring-fixes (72b2ef5) with main (4734c53)

Summary

⚡ 1 improvements
❌ 1 regressions
✅ 15 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark main sammy/docstring-fixes Change
test_iter_rows_first_row[100 Small Files] 312 ms 355.2 ms -12.16%
test_show[100 Small Files] 23.6 ms 15.8 ms +49.59%

@samster25 samster25 marked this pull request as ready for review December 6, 2024 07:33
@samster25 samster25 requested a review from jaychia December 6, 2024 07:33
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.60%. Comparing base (4734c53) to head (72b2ef5).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3506   +/-   ##
=======================================
  Coverage   77.60%   77.60%           
=======================================
  Files         707      707           
  Lines       86174    86174           
=======================================
  Hits        66873    66873           
  Misses      19301    19301           
Files with missing lines Coverage Δ
daft/__init__.py 23.68% <ø> (ø)
daft/analytics.py 97.19% <ø> (ø)
daft/api_annotations.py 95.38% <ø> (ø)
daft/arrow_utils.py 96.96% <ø> (ø)
daft/catalog/__init__.py 56.25% <ø> (ø)
daft/catalog/python_catalog.py 0.00% <ø> (ø)
daft/context.py 87.19% <ø> (ø)
daft/dataframe/dataframe.py 85.74% <ø> (ø)
daft/datatype.py 91.89% <ø> (ø)
daft/delta_lake/delta_lake_scan.py 77.77% <100.00%> (ø)
... and 49 more

@samster25 samster25 merged commit 0889bbf into main Dec 6, 2024
42 of 43 checks passed
@samster25 samster25 deleted the sammy/docstring-fixes branch December 6, 2024 18:34
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.

2 participants