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(rust): Fix incorrect column name in LazyFrame.sort doc example #15658

Merged
merged 4 commits into from
Apr 17, 2024

Conversation

wsyxbcl
Copy link
Contributor

@wsyxbcl wsyxbcl commented Apr 15, 2024

Copy link

codecov bot commented Apr 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.33%. Comparing base (70b71da) to head (681bae5).
Report is 18 commits behind head on main.

❗ Current head 681bae5 differs from pull request most recent head 9b189c1. Consider uploading reports for the commit 9b189c1 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15658      +/-   ##
==========================================
- Coverage   81.33%   81.33%   -0.01%     
==========================================
  Files        1374     1374              
  Lines      176471   176471              
  Branches     2544     2544              
==========================================
- Hits       143539   143528      -11     
- Misses      32450    32460      +10     
- Partials      482      483       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

codspeed-hq bot commented Apr 15, 2024

CodSpeed Performance Report

Merging #15658 will not alter performance

Comparing wsyxbcl:patch-2 (9b189c1) with main (e218203)

Summary

✅ 22 untouched benchmarks

Copy link
Contributor

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

Well spotted! However, The example below is still using 'a', 'b' as columns. Better to just update the preceeding text "sort dataframe by sepal width column" to "Sort DataFrame by a single column". Then it all makes sense.

@stinodego stinodego changed the title correct column name in doc docs(rust): Fix incorrect column name in DataFrame.sort doc example Apr 15, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation rust Related to Rust Polars labels Apr 15, 2024
@stinodego stinodego changed the title docs(rust): Fix incorrect column name in DataFrame.sort doc example docs(rust): Fix incorrect column name in LazyFrame.sort doc example Apr 15, 2024
@wsyxbcl
Copy link
Contributor Author

wsyxbcl commented Apr 15, 2024 via email

@stinodego
Copy link
Contributor

You're right. Then maybe update the last example to use sepal.width and petal.width or something, instead of a and b.

@wsyxbcl
Copy link
Contributor Author

wsyxbcl commented Apr 16, 2024

You're right. Then maybe update the last example to use sepal.width and petal.width or something, instead of a and b.

Sure, then we stick to the iris dataset as before

Copy link
Contributor

@stinodego stinodego left a comment

Choose a reason for hiding this comment

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

I saw some inconsistency in using sepal.width vs sepal_width so I updated all references to use the same column names as the small dataset we have in the docs folder.

This can be merged, thanks 👍

@stinodego stinodego merged commit e39ba62 into pola-rs:main Apr 17, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation rust Related to Rust Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants