search

JuliaArrays / ReadOnlyArrays.jl

A wrapper type around AbstractArray that is read-only
Other
27 stars 5 forks source link

Add convenience features #5

Closed wmanning-cra closed 2 years ago

wmanning-cra commented 2 years ago
  1. Add constructors that support type parameters, so that custom user aliases like MyGroup = ReadOnlyArray{Float64, 3} can be constructed
  2. Add an implicit conversion from AbstractArray{T, N} to ReadOnlyArray{T, N}
  3. Add aliases ReadOnlyVector and ReadOnlyMatrix
bkamins commented 2 years ago

@wmanning-cra - I have a question. I am not using this package currently. Do you want to be added to its maintainers (or even get it transferred to your account)? Then you could make PRs faster and make releases as you would find it useful?

wmanning-cra commented 2 years ago

@bkamins Sorry, I had to double-check with my supervisor as I am mostly using this stuff at work, but they have no problem with me becoming a maintainer for this package.

So yes, I would like to be added to the list of maintainers.

bkamins commented 2 years ago

I have added you to the project. After you accept the invitation you will be able to merge this PR when you are happy with it and make a release (the same for further changes you would want to make).

Thank you!

wmanning-cra commented 2 years ago

Thanks! I'm pretty inexperienced with the more public-facing features of Github like releases, tags, etc., as well as the proper "etiquette" for Julia packages, so I might have a question or two about how to do it properly. For example, should I be updating the project version and tagging a new release on this branch, or on a subsequent one? I can't think of any other work I'd like to pull into this new release.

bkamins commented 2 years ago

So this is an excellent opportunity to learn this as this is a package that is relatively simple. Thank you for working on this.

It is OK to bump the version in the PR. Since there are many user-facing changes in this PR the release should be 0.2. Typically you want to "Squash and merge" the PR to have one commit on master branch. After this is done follow the instructions in https://github.com/JuliaRegistries/Registrator.jl

wmanning-cra commented 2 years ago

@bkamins Thanks for the help! Looks like the Registrator is happy with the project, and there's a new tag + new release out.

bkamins commented 2 years ago

Thank you!