General icon indicating copy to clipboard operation
General copied to clipboard

New package: Out v0.1.0

Open JuliaRegistrator opened this issue 2 years ago • 4 comments

  • Registering package: Out
  • Repository: https://github.com/b-fg/Out.jl
  • Created by: @b-fg
  • Version: v0.1.0
  • Commit: e650a1a332b44a3f297902a279b22e673905a21e
  • Git reference: HEAD
  • Description: Pretty print for a variable(s) using display-like output and a @show-like header.

JuliaRegistrator avatar Aug 15 '22 10:08 JuliaRegistrator

Your new package pull request does not meet the guidelines for auto-merging. Please make sure that you have read the General registry README and the AutoMerge guidelines. The following guidelines were not met:

  • Name is not at least 5 characters long

  • There is no compat entry for julia.

  • Package name similar to 12 existing packages.

    Similar package names
    1. Similar to Ant. Damerau-Levenshtein distance 2 is at or below cutoff of 2. Normalized visual distance 2.46 is at or below cutoff of 2.50.
    2. Similar to Git. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    3. Similar to ODE. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    4. Similar to Lux. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    5. Similar to Mux. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    6. Similar to Run. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    7. Similar to Octo. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    8. Similar to Org. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    9. Similar to Jute. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    10. Similar to Ogg. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    11. Similar to Opus. Damerau-Levenshtein distance 2 is at or below cutoff of 2.
    12. Similar to OAuth. Damerau-Levenshtein distance 2 is at or below cutoff of 2.

Note that the guidelines are only required for the pull request to be merged automatically. However, it is strongly recommended to follow them, since otherwise the pull request needs to be manually reviewed and merged by a human.

After you have fixed the AutoMerge issues, simple retrigger Registrator, which will automatically update this pull request. You do not need to change the version number in your Project.toml file (unless of course the AutoMerge issue is that you skipped a version number, in which case you should change the version number).

If you do not want to fix the AutoMerge issues, please post a comment explaining why you would like this pull request to be manually merged.

Since you are registering a new package, please make sure that you have also read the package naming guidelines: https://julialang.github.io/Pkg.jl/dev/creating-packages/#Package-naming-guidelines-1


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.

github-actions[bot] avatar Aug 15 '22 11:08 github-actions[bot]

Hi, I would like this PR to be manually merged since the package name already encapsulates all the information in a clear way. Additionally, it does not clash with any other package name and the only issue that seems to be present is that it is too short. If that is indeed the case, I can change it to Output.jl, although I am not sure why it would be necessary. Thanks!

[noblock]

b-fg avatar Aug 15 '22 11:08 b-fg

Nice little package! I'm no decision maker on these things, but for what it's worth, I think the name is fine and support it.

If it's decided that this package name isn't acceptable for some reason, can I suggest the names "Showln.jl" and @showln? It's not a perfect name because the analogy between this and @show is not quite the same as the analogy between print and println. On the other hand, I think this is more faithful to the show function than @show itself is, so 🤷.

I've had a @showln in my startup.jl for a long time now that basically does this, and I'd be glad to replace it with a package. [noblock]

MasonProtter avatar Aug 15 '22 16:08 MasonProtter

Thanks @MasonProtter. I will keep that in mind in case I finally need to change it :)

[noblock]

b-fg avatar Aug 15 '22 18:08 b-fg

Maybe something like OutMacro would also work? Then it would be pretty obvious what using OutMacro at the top of some script is doing.

[noblock]

mcabbott avatar Aug 30 '22 17:08 mcabbott

Thanks for the input @mcabbott .I still prefer just Out to be honest. Do packages that export macros in general include "Macro" in the name? If that is the general trend, I am happy to modify it.

[noblock]

b-fg avatar Aug 30 '22 21:08 b-fg

This pull request has been inactive for 30 days and will be automatically closed 7 days from now. If this pull request should not be closed, please either (1) fix the AutoMerge issues and re-trigger Registrator, which will automatically update the pull request, or (2) post a comment explaining why you would like this pull request to be manually merged. [noblock]

github-actions[bot] avatar Sep 30 '22 13:09 github-actions[bot]

This pull request has been inactive for more than 30 days and has automatically been closed. Feel free to register your package or version again once you fix the AutoMerge issues. [noblock]

github-actions[bot] avatar Oct 08 '22 12:10 github-actions[bot]