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: Revise and improve 'Concepts' section #19087

Merged
merged 8 commits into from
Oct 7, 2024

Conversation

rodrigogiraoserrao
Copy link
Collaborator

No description provided.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Oct 3, 2024
@rodrigogiraoserrao rodrigogiraoserrao force-pushed the user-guide-pass branch 4 times, most recently from c3e7eca to aabbc7f Compare October 4, 2024 13:59
@rodrigogiraoserrao rodrigogiraoserrao marked this pull request as ready for review October 4, 2024 14:25
Copy link

codecov bot commented Oct 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.81%. Comparing base (d31bbf4) to head (5e2e040).
Report is 49 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #19087   +/-   ##
=======================================
  Coverage   79.81%   79.81%           
=======================================
  Files        1531     1531           
  Lines      208573   208576    +3     
  Branches     2913     2913           
=======================================
+ Hits       166472   166482   +10     
+ Misses      41550    41543    -7     
  Partials      551      551           

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

Copy link
Member

@ritchie46 ritchie46 left a comment

Choose a reason for hiding this comment

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

A good introduction. I have left some comments, but looks good overall. 👍

Simplify the dataframe used in the section 'Reading & Writing' of the getting started page and remove dead code from the respective source files. A smaller DF is better because the focus is on reading/writing, not on the data types supported.
It also creates a clearer distinction between the DF from this section and the DF of the section on expressions.
The main focus was on picking one example dataframe that could be used throughout the whole page and to write a more coherent narrative.
Translate all the Python examples to Rust.
Since there is now a coherent story throughout the whole 'getting started' page it no longer makes sense to have three different files with examples for each language.
Copy link
Collaborator Author

@rodrigogiraoserrao rodrigogiraoserrao left a comment

Choose a reason for hiding this comment

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

Thanks for the review comments. I've addressed all of them and left as “unresolved” those which need you to look at what my changes were.

@ritchie46 ritchie46 merged commit d7c93bb into pola-rs:main Oct 7, 2024
22 of 23 checks passed
@rodrigogiraoserrao rodrigogiraoserrao deleted the user-guide-pass branch October 7, 2024 16:32
@c-peters c-peters added the accepted Ready for implementation label Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Ready for implementation documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants