-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
News and compatibility annotations for Julia 1.1 #30230
Conversation
9d444a6
to
6ecf58e
Compare
OMG, you two are saints! |
Should we add a note to CONTRIBUTING.md? Something along the lines of:
|
This is amazing. I was just starting to worry about how we were going to do this for this release and who was going to do it (me?) but now here it is :) |
I cannot emphasize how wonderful it is that you two did this. Thank you sooo much! ❤️❤️❤️ |
@mbauman suggested using a different icon (arrow-circle-up) for the compat notes. For that we just need to add this to the CSS:
The same change needs to be done in Pkg as well to keep the style consistent. |
6ecf58e
to
a02ba64
Compare
It's not a very strong preference — which is why I figured I'd raise the possibility on slack instead of here. My thought is just to differentiate things a bit more from warnings, but the green does a pretty good job of that. And we also use the encircled ! for |
31eaaaa
to
cceb675
Compare
changes between Julia 1.0 and 1.1, including: - Custom .css-style for compat admonitions. - Information about compat annotations to CONTRIBUTING.md. - NEWS.md entry for PRs #30090, #30035, #30022, #29978, #29969, #29858, #29845, #29754, #29638, #29636, #29615, #29600, #29506, #29469, #29316, #29259, #29178, #29153, #29033, #28902, #28761, #28745, #28708, #28696, #29997, #28790, #29092, #29108, #29782 - Compat annotation for PRs #30090, #30013, #29978, #29890, #29858, #29827, #29754, #29679, #29636, #29623, #29600, #29440, #29316, #29259, #29178, #29157, #29153, #29033, #28902, #28878, #28761, #28708, #28156, #29733, #29670, #29997, #28790, #29092, #29108, #29782, #25278 - Documentation for broadcasting CartesianIndices (#30230). - Documentation for Base.julia_cmd(). - Documentation for colon constructor of CartesianIndices (#29440). - Documentation for ^(::Matrix, ::Number) and ^(::Number, ::Matrix). - Run NEWS-update.jl. Co-authored-by: Morten Piibeleht <morten.piibeleht@gmail.com> Co-authored-by: Fredrik Ekre <ekrefredrik@gmail.com>
changes between Julia 1.0 and 1.1, including: - Custom .css-style for compat admonitions. - Information about compat annotations to CONTRIBUTING.md. - NEWS.md entry for PRs #30090, #30035, #30022, #29978, #29969, #29858, #29845, #29754, #29638, #29636, #29615, #29600, #29506, #29469, #29316, #29259, #29178, #29153, #29033, #28902, #28761, #28745, #28708, #28696, #29997, #28790, #29092, #29108, #29782 - Compat annotation for PRs #30090, #30013, #29978, #29890, #29858, #29827, #29754, #29679, #29636, #29623, #29600, #29440, #29316, #29259, #29178, #29157, #29153, #29033, #28902, #28878, #28761, #28708, #28156, #29733, #29670, #29997, #28790, #29092, #29108, #29782, #25278 - Documentation for broadcasting CartesianIndices (#30230). - Documentation for Base.julia_cmd(). - Documentation for colon constructor of CartesianIndices (#29440). - Documentation for ^(::Matrix, ::Number) and ^(::Number, ::Matrix). - Run NEWS-update.jl. Co-authored-by: Morten Piibeleht <morten.piibeleht@gmail.com> Co-authored-by: Fredrik Ekre <ekrefredrik@gmail.com>
cceb675
to
ebbabf5
Compare
Me and @mortenpi have gone through the ~570 PRs that have been merged since Julia 1.0 (https://docs.google.com/spreadsheets/d/1PThPlhFwlkcmmEpe8JcJ-XyTdU-I1lmEh7iCw8AvFSM/edit?usp=sharing20) in preparation for the 1.1 release. We have added news and compatibility annotations for changes worthy of that.
Since we now have one doc for all of Julia 1.X (#26825) we have thus added small
!!! compat
notes to the manual for e.g. new functions and new behaviors. For a taste of what these annotations look like see e.g. https://julialang.github.io/Pkg.jl/dev/registries/Walking through the PRs like this is not very efficient (and pretrty boring), so for future features I ask people to add these annotations together with NEWS.