pola-rs / polars

Dataframes powered by a multithreaded, vectorized query engine, written in Rust
https://docs.pola.rs
Other
30.17k stars 1.94k forks source link

Set up versioning for user guide #11105

Open kotval opened 1 year ago

kotval commented 1 year ago

https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/

Once you build an application with polars, you're often stuck on a version untili you need to upgrade. Not being able to see the docs from the version you are using is a pain, and upgrading can break other things. Please set up the version tags in mkdocs material as described in the link above.

stinodego commented 1 year ago

The Python API reference now has versioning support.

It would be nice if the user guide could also have versioning support. There are a few issues though:

bhogan-mitre commented 1 year ago

Related: when the API reference gives a choice of "dev", "0.19 (stable)", or "0.18", it's not clear to the user exactly what that refers to. For example, does 0.18 point at the last release in the 0.18 line (0.18.15 from Aug 15)? What does "stable" mean in the context of 0.19 when there seem to be releases every week or so? How is that different than dev?

If those things could be clarified in the API reference and the user guide, that would be very helpful. I'm looking to pin a reasonably stable version for production code, and it would be great if the documentation was available to match that. Thank you for considering!

Screenshot 2023-10-18 at 11 29 31 AM
stinodego commented 1 year ago

dev refers to the latest commit on the main branch, while stable refers to the most recent release.

0.x points to the latest 0.x release, so 0.19 currently points to 0.19.9.

We do not keep docs for every patch version.