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: Rewrite 'Getting started' page #19028

Merged
merged 6 commits into from
Oct 1, 2024

Conversation

rodrigogiraoserrao
Copy link
Collaborator

Main focus was on picking a single example dataframe that could be used throughout the page in a coherent manner.

I'm sharing the page rewrite before fixing the Rust examples.
I recommend checking out the PR branch, serving the docs with mkdocs serve, and reading the new page in the browser, instead of trying to read the markdown file + checking the code examples in expressions.py.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Sep 30, 2024

Polars supports all types of join (e.g. left, right, inner, outer). Let's have a closer look on how to `join` two `DataFrames` into a single `DataFrame`. Our two `DataFrames` both have an 'id'-like column: `a` and `x`. We can use those columns to `join` the `DataFrames` in this example.
Copy link
Member

Choose a reason for hiding this comment

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

Yeah, i don' think that's all. :')

Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.82%. Comparing base (76d0363) to head (049a91e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #19028      +/-   ##
==========================================
- Coverage   79.84%   79.82%   -0.03%     
==========================================
  Files        1525     1525              
  Lines      207823   207823              
  Branches     2913     2913              
==========================================
- Hits       165946   165898      -48     
- Misses      41326    41374      +48     
  Partials      551      551              

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

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.
@ritchie46 ritchie46 marked this pull request as ready for review October 1, 2024 14:21
@ritchie46 ritchie46 requested a review from c-peters as a code owner October 1, 2024 14:21
@ritchie46 ritchie46 merged commit becead9 into pola-rs:main Oct 1, 2024
13 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 python Related to Python Polars rust Related to Rust Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants