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

New package: Targets v0.1.0 #113040

Merged
merged 1 commit into from
Aug 16, 2024

Conversation

JuliaRegistrator
Copy link
Contributor

@JuliaRegistrator JuliaRegistrator commented Aug 13, 2024

Copy link
Contributor

github-actions bot commented Aug 13, 2024

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. New package registration

Please make sure that you have read the package naming guidelines.

2. AutoMerge Guidelines are all met! ✅

Your new package registration met all of the guidelines for auto-merging and is scheduled to be merged when the mandatory waiting period (3 days) has elapsed.

3. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

UUID: 911cb31e-70cd-4e9d-a353-3054e2e6a3a8
Repo: https://github.com/codedthinking/Targets.jl.git
Tree: a56a62719789ed8a5058168918aa55b7f84b8c1b

Registrator tree SHA: 17aec322677d9b81cdd6b9b9236b09a3f1374c6a
@JuliaRegistrator JuliaRegistrator force-pushed the registrator-targets-911cb31e-v0.1.0-ad0c541142 branch from 3b2573c to 86e8842 Compare August 13, 2024 14:43
@korenmiklos
Copy link

korenmiklos commented Aug 13, 2024

The names Markets and Targets are sufficiently distinct so that they will not be mistaken. The name Targets is motivated by https://cran.r-project.org/package=targets. Please merge. [noblock]

@goerz
Copy link
Member

goerz commented Aug 13, 2024

Can I suggest ComputationalTargets? Just Targets might be a little too general [noblock]

@korenmiklos
Copy link

Can I suggest ComputationalTargets? Just Targets might be a little too general [noblock]

Targets is a much better name both because it is short and the usual name for these types of objects. GNU Make defines "targets", the corresponding R library is called "targets". [noblock]

@goerz
Copy link
Member

goerz commented Aug 13, 2024

Well, “short” is not something we optimize for. The naming guidelines emphasize “Err on the side of clarity, even if clarity seems long-winded to you.” Naming conventions in R or other languages are different from Julia and are not a good guide. When Targets popped up in the feed, I did not have any idea what this package would be about, which is a sign that the name is not descriptive enough. I could see myself coming around to Targets, but maybe we should get a second opinion.

[noblock]

@tecosaur
Copy link
Contributor

Not to dogpile 😅, but from a glance at the package it does seem like a more verbose name might benefit this package. In particular I'm thinking of these two guidelines from https://pkgdocs.julialang.org/v1/creating-packages/#Package-naming-guidelines

  • Err on the side of clarity, even if clarity seems long-winded to you.
  • A less systematic name may suit a package that implements one of several possible approaches to its domain.

With that second point in particular, "targets" can only mean one thing in GNU Make, but there are both multiple ways of interpreting "Targets" in the context of Julia, and approaching this problem[1]. While this package is one interpretation/approach, it seems slightly presumptuous (to me at least) to claim the most generic name.

[1]: For example DataFlowTasks.jl does "targets" within a single function, and DataToolkit.jl does this for computed datasets.

[noblock]

@korenmiklos
Copy link

korenmiklos commented Aug 15, 2024

Thank you all for your valuable input on the package naming.

I'd like to make a case for retaining "Targets":

  1. "Targets" is the established name in several similar domains (e.g., Make, R's targets package), not a convenience shortening.
  2. It aligns with Julia's guideline on plural names for packages providing new types.
  3. There doesn't seem to be a naming conflict with existing Julia packages.
  4. Similar functionality in Julia is provided by the more complex packages DrWatson.jl, DataToolkit.jl, DataFlowTasks.jl, for example. These names are longer but not necessarily clearer to users.
  5. "Targets" signals the package's simplicity and focused functionality: caching target = recipe(sources...) style function calls.

While it may appear broad, I believe it's sufficiently clear for the intended users and accurately reflects the package's scope. A longer name might not enhance clarity in this case.

I'm open to your thoughts if you feel I've overlooked any important considerations. Your expertise in the Julia ecosystem is invaluable.

Thank you again for your time and insights. [noblock]

@julianhinz
Copy link

julianhinz commented Aug 15, 2024

As discussed by the OP, targets seems very clear to any R user or even user of make. Making the name longer, like the suggested ComputationalTargets, does not really help those that do not recognize targets alone either.
[noblock]

@goerz
Copy link
Member

goerz commented Aug 15, 2024

[noblock] I think I can come around to Targets, personally.

@goerz
Copy link
Member

goerz commented Aug 15, 2024

@korenmiklos Your first comment is was also blocking, so you'll have to edit that to allow the merge to go through [noblock]

@JuliaTagBot JuliaTagBot merged commit eb762d2 into master Aug 16, 2024
15 of 16 checks passed
@JuliaTagBot JuliaTagBot deleted the registrator-targets-911cb31e-v0.1.0-ad0c541142 branch August 16, 2024 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants