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

breaking changes for Trixi.jl v0.5 #1302

Merged
merged 19 commits into from
Dec 24, 2022
Merged

breaking changes for Trixi.jl v0.5 #1302

merged 19 commits into from
Dec 24, 2022

Conversation

ranocha
Copy link
Member

@ranocha ranocha commented Dec 16, 2022

This includes a first set of breaking changes for Trixi.jl v0.5 described in #938.

@jlchan Could you please check that I removed only the DGMulti code that you intended to be removed?

I will leave this in draft mode until we are ready for the breaking release of Trixi.jl. We also need to update the compat bounds of Trixi.jl at Trixi2Vtk.jl to create our documentation here.

@ranocha ranocha requested a review from jlchan December 16, 2022 12:33
@ranocha ranocha mentioned this pull request Dec 16, 2022
4 tasks
Copy link
Contributor

@jlchan jlchan left a comment

Choose a reason for hiding this comment

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

@ranocha thanks for organizing this.

For DGMulti, it would be nice to make the DGMultiMesh constructors consistent so that dg is the first argument. This would be a breaking change. If there is some time before v0.5, I can take care of that sometime next week.

src/solvers/dgmulti/flux_differencing.jl Show resolved Hide resolved
src/solvers/dgmulti/flux_differencing.jl Show resolved Hide resolved
src/solvers/dgmulti/types.jl Outdated Show resolved Hide resolved
@ranocha
Copy link
Member Author

ranocha commented Dec 18, 2022

@ranocha thanks for organizing this.

For DGMulti, it would be nice to make the DGMultiMesh constructors consistent so that dg is the first argument. This would be a breaking change. If there is some time before v0.5, I can take care of that sometime next week.

That sounds good to me - it would be great if you could introduce the corresponding deprecations next week 👍

@jlchan
Copy link
Contributor

jlchan commented Dec 20, 2022

@ranocha I added the deprecations, along with some internal cleanup.

I removed a constructor in 2a0205d which is, as far as I can tell, unused. I wasn't sure how to deprecate this properly - do we need to?

@ranocha ranocha force-pushed the hr/breaking_changes branch from 1270534 to 28a620f Compare December 20, 2022 07:09
@ranocha
Copy link
Member Author

ranocha commented Dec 20, 2022

I added the deprecations, along with some internal cleanup.

Thanks!

I removed a constructor in 2a0205d which is, as far as I can tell, unused. I wasn't sure how to deprecate this properly - do we need to?

No, I think its okay. Was it documented, e.g., via a docstring? If so, it would be great if you could mention it in NEWS.md.

@jlchan
Copy link
Contributor

jlchan commented Dec 20, 2022

No docstring. I'll add it to the news file soon

@ranocha
Copy link
Member Author

ranocha commented Dec 20, 2022

Thanks!

@ranocha ranocha marked this pull request as ready for review December 23, 2022 12:46
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

Two small comments, otherwise this LGTM!

src/Trixi.jl Show resolved Hide resolved
NEWS.md Show resolved Hide resolved
Co-authored-by: Michael Schlottke-Lakemper <[email protected]>
@ranocha ranocha requested a review from sloede December 23, 2022 14:59
NEWS.md Show resolved Hide resolved
Copy link
Member

@sloede sloede left a comment

Choose a reason for hiding this comment

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

🎉

@ranocha ranocha merged commit e072790 into main Dec 24, 2022
@ranocha ranocha deleted the hr/breaking_changes branch December 24, 2022 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants