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

StaticArraysCore transition #1045

Merged
merged 7 commits into from
Jun 24, 2022
Merged

Conversation

mateuszbaran
Copy link
Collaborator

This PR implements transition to StaticArraysCore.jl, an interface package, as discussed here: #1023 .

@ranocha
Copy link
Contributor

ranocha commented Jun 17, 2022

Will the docstrings for SArray etc. still be displayed in the API docs?

@mateuszbaran
Copy link
Collaborator Author

Good point, they are currently not. I'll try to fix it.

@mateuszbaran
Copy link
Collaborator Author

With the last commit the docstrings show for me locally in the documentation.

Copy link
Contributor

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Nice 👍

import StaticArraysCore: SizedArray, SizedVector, SizedMatrix
import StaticArraysCore: check_array_parameters, convert_ntuple

# end of StaticArraysCore imports
Copy link
Member

Choose a reason for hiding this comment

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

Move the (re)-exports below to this block too maybe?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure, done.

@fredrikekre
Copy link
Member

Could you add some docs about this? I.e. describe why it is split like this and that if you just want to add dispatch for StaticArrays you can depend only on the core package (I guess this is the main reason for this split?)

@mateuszbaran
Copy link
Collaborator Author

Sure, I'll add some docs about this split. The motivation is primarily covered in this comment: #1023 (comment) .

Copy link
Collaborator

@thchr thchr left a comment

Choose a reason for hiding this comment

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

This looks good to me.

I remember it being mentioned that StaticArrays.LU and StaticArrays.QR are also being extended by downstream packages; but it would probably be better to just completely drop those rather than to include them in StaticArraysCore.jl at all.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Thomas Christensen <tchr@mit.edu>
@mateuszbaran
Copy link
Collaborator Author

Extending QR and LU from StaticArrays.jl seems like a rare use case so maybe let's leave it in StaticArrays.jl for now. We can always move them to StaticArraysCore.jl later without any breaking changes.

@mateuszbaran mateuszbaran merged commit 29a76ec into master Jun 24, 2022
@mateuszbaran mateuszbaran deleted the mbaran/static-arrays-core-transition branch June 24, 2022 12:45
@oschulz
Copy link

oschulz commented Jun 24, 2022

Is this going to be StaticArrays v1.5.0 ?

@mateuszbaran
Copy link
Collaborator Author

Yes, I'll tag it in a moment.

@oschulz
Copy link

oschulz commented Jun 24, 2022

Thanks!

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.

5 participants