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

First steps #3

Open
jw3126 opened this issue Sep 10, 2020 · 19 comments
Open

First steps #3

jw3126 opened this issue Sep 10, 2020 · 19 comments

Comments

@jw3126
Copy link
Member

jw3126 commented Sep 10, 2020

Here is how I think we should proceed:

  • Make the github repo public. @tkf can you review the package? Especially check if I inserted your name + mail correctly in all appropriate places.
  • Register the package and put a note in Setfield.jl README that this is an experimental successor.
  • Wait for Julia 1.6 to come out. Then announce the package on discourse and make it the official successor of Setfield.jl
@tkf
Copy link
Member

tkf commented Sep 10, 2020

Thanks a lot for doing this!

I checked my name and email. I agree that it's a good idea to link from Setfield.jl that this package is an experimental successor.

  • Wait for Julia 1.6 to come out.

Did you need some 1.6 features? I'm just curious why you'd want to wait for 1.6 (and added compat julia = "1.6"). I don't have a strong opinion on this but, since 1.6 is a feature-based release, the release date is less clear than usual. So I think it could be a bit frustrating to wait for 1.6 (just a speculation, though).

@jw3126
Copy link
Member Author

jw3126 commented Sep 10, 2020

We need to return a struct instead of a lambda. https://github.com/JuliaLang/julia/pull/35980/files#diff-a21a7fc275830bf9efb5b7c17c4fb98eR877

The most critical use is set on composed lens:
https://github.com/JuliaObjects/Accessors.jl/blob/master/src/lens.jl#L83-L91

@tkf
Copy link
Member

tkf commented Sep 10, 2020

Ah, thanks. That makes sense. We could do a hack like JuliaData/DataFrames.jl#2274 (comment) (or put it in Compat.jl) but it may not be worth doing this since 1.6 will be the next LTS.

Meanwhile, I think we better send a PR to document Base.ComposedFunction and then promote it to the public API (including its fields). I'll do this at some point but don't wait for me if you want to write it.

@tkf
Copy link
Member

tkf commented Sep 10, 2020

I guess documenting ComposedFunction is a very low priority task. Nobody wants to break DataFrames.jl.

@jw3126
Copy link
Member Author

jw3126 commented Sep 10, 2020

Why does documenting ComposedFunction break DataFrames?

@tkf
Copy link
Member

tkf commented Sep 10, 2020

Sorry, it was cryptic 😅. I meant that, since virtually nobody wants to break DataFrames.jl, ComposedFunction would not be changed even if we don't send a PR to promote it to a public API.

@jw3126
Copy link
Member Author

jw3126 commented Sep 10, 2020

Ah, I see. So to be maximally safe, we should just drop all requirements on Julia and do using DataFrames: ComposedFunction 😄

@jw3126
Copy link
Member Author

jw3126 commented Sep 10, 2020

JuliaLang/julia#37517

@jw3126
Copy link
Member Author

jw3126 commented Sep 20, 2020

@tkf I am going to make this repo public on monday if there are no objections from your side.

@tkf
Copy link
Member

tkf commented Sep 21, 2020

Sounds great! No objections.

@jw3126
Copy link
Member Author

jw3126 commented Oct 3, 2020

@tkf I would like to tag a first release (without discourse announcement yet). What do you think?

@jw3126
Copy link
Member Author

jw3126 commented Oct 16, 2020

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Registration pull request created: JuliaRegistries/General/23028

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 4e839837c29337650e0c8bc8c9e92a54445289c8
git push origin v0.1.0

@jw3126
Copy link
Member Author

jw3126 commented Oct 16, 2020

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Registration pull request updated: JuliaRegistries/General/23028

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 4e839837c29337650e0c8bc8c9e92a54445289c8
git push origin v0.1.0

@jw3126
Copy link
Member Author

jw3126 commented Oct 18, 2020

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Registration pull request updated: JuliaRegistries/General/23028

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 4e839837c29337650e0c8bc8c9e92a54445289c8
git push origin v0.1.0

@tkf
Copy link
Member

tkf commented Nov 25, 2020

Hi, sorry for the long absence, and thanks so much for pushing this project forward!

If you prefer announcing it on discourse, I think that's good too. But a few things on my wish list off the top of my head are:

@jw3126
Copy link
Member Author

jw3126 commented Nov 25, 2020

You are right, the docs could use some love. And it makes a lot of sense to improve them before announcing. If you want to tackle it that's great! Feel free to replace or delete any docs I wrote.
I can update DataTools.jl it's a package I wanted to take a look at anyway.

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

No branches or pull requests

3 participants