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: Expand plotting docs #19719

Merged
merged 8 commits into from
Dec 7, 2024
Merged

Conversation

MarcoGorelli
Copy link
Collaborator

@MarcoGorelli MarcoGorelli commented Nov 10, 2024

In summary, this:

  • shows a few more common configuration options in the visualisation guide (axis labels, title)
  • links to Altair's configuration docs
  • add tips for some common configuration tasks (label rotation, opacity, width / height / title)

screenshots of how it looks (current user guide for comparison https://docs.pola.rs/user-guide/misc/visualization/)

image

image

image

image

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Nov 10, 2024
Copy link

codecov bot commented Dec 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.62%. Comparing base (dc54699) to head (47aca4f).
Report is 23 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #19719      +/-   ##
==========================================
- Coverage   79.63%   79.62%   -0.01%     
==========================================
  Files        1564     1564              
  Lines      217478   217478              
  Branches     2473     2473              
==========================================
- Hits       173181   173177       -4     
- Misses      43728    43732       +4     
  Partials      569      569              

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

@MarcoGorelli MarcoGorelli marked this pull request as ready for review December 1, 2024 14:17
@MarcoGorelli
Copy link
Collaborator Author

@rodrigogiraoserrao fancy taking a look?

Copy link
Collaborator

@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.

I only have a comment: it feels like there was something missing in a docstring.
If I misinterpreted it, just let me know and I'll change my review status.

Sorry I missed the PR!

Comment on lines 652 to 653
- Set the x-axis title by passing ``x=alt.X('length', title='Length')`` instead
of ``x='length'``.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This last bullet point feels incomplete:
Set the x-axis title by passing x=alt.X(...) instead of x=...... where? Where do I pass it?

(Also, you have the same list in visualization.md and in series.py but this fourth item is only present in this list. It looks like all three lists should look the same but I'm not sure, so I'm just flagging this here in case you missed it.)

@BartSchuurmans
Copy link
Contributor

This documentation is exactly what I needed!

I noticed that some of the examples of the different libraries have the x/y axes swapped; might be nice to make that consistent.

@MarcoGorelli
Copy link
Collaborator Author

MarcoGorelli commented Dec 5, 2024

good points, thanks both for your reviews! have addressed

Copy link
Collaborator

@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.

Looks good to me :D

@MarcoGorelli
Copy link
Collaborator Author

awesome, thanks!

@MarcoGorelli MarcoGorelli merged commit 958d1ef into pola-rs:main Dec 7, 2024
17 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.

3 participants