-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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: Add Development
and Releases
sections to the documentation
#11932
Conversation
Some near-subatomic grammar tweaks/suggestions from me 🤣 |
Co-authored-by: Alexander Beedie <[email protected]>
Thanks Alex - helpful for a non-native speaker like me :) |
docs/development/versioning.md
Outdated
|
||
!!! warning Rust users only | ||
|
||
The Rust API for Polars is currently not considered stable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we word this less drastically? Maybe that we are more certain about the lazy API, but that the internals may expect more breaking API changes. Also because it is harder to hide the API than it is in python.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, will change the wording here!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't really have to say anything about the stability of the API. We just need to mention that we don't deprecate things in Rust. I rewrote it to:
Breaking changes to the Rust API are not deprecated first, but will be listed in the changelog.
Supporting deprecated functionality would slow down development too much at this point in time.
f6c123f
to
66070ca
Compare
Alright. Good to go and good addition. |
Changes
After this is released, I will update CONTRIBUTING.md to point to the contributing information in the docs.