New package: VerifyMacros v0.1.0

[JuliaRegistrator]

• Registering package: VerifyMacros
• Repository: https://github.com/NittanyLion/VerifyMacros.jl
• Created by: @NittanyLion
• Version: v0.1.0
• Commit: a5c6682ddf720f4cc370ef7f86dbf73a640466fc
• Reviewed by: @NittanyLion
• Reference: Registration NittanyLion/VerifyMacros.jl#2
• Description: A collection of macros for verifying types, axes, fields, properties, keys, and supertypes.

[github-actions]

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.

[aplavin]

Hmm, isn't it just the built-in @assert:

@verifytrue x > 5
# vs
@assert x > 5

@verifykey d :a
# vs
@assert haskey(d, :a)

? Doesn't seem shorter or easier to type...

[NittanyLion]

[noblock] @aplavin @verifytrue is mostly included for the sake of completeness, albeit that there is a subtle difference in that the compiler may remove @Assert statements at certain optimization levels.

That was for @verifytrue. For the other statements, it also automatically generates an appropriate and styled statement, which is not in @Assert.

Hmm, isn't it just the built-in @assert:

@verifytrue x > 5
# vs
@assert x > 5

@verifykey d :a
# vs
@assert haskey(d, :a)

? Doesn't seem shorter or easier to type...

[NittanyLion]

[noblock] Another difference is that in the batch version, it actually tells you which restriction is violated. See image below.

[aplavin]

For the other statements, it also automatically generates an appropriate and styled statement, which is not in @Assert.

There's ArgCheck.jl that does exactly this – better error messages for assert-like checks.
It's quite popular already, with almost a thousand dependents.

Did you check it out? Can be worth improving ArgCheck if some features are missing there – it will help existing users as well as potential future ones :)

[NittanyLion]

[noblock]

Just did. Yes, that's a nice package too and it does have overlapping functionality.

I would argue that there is room for multiple packages with similar functionality, much like I prefer AxisKeys to any of the many similar alternatives, but others do not.

But if the powers that be prefer this package not to be in the registry, that's fine.

[aplavin]

If there's something missing in ArgCheck (and present in VerifyMacros), it would generally be beneficial for users to have the corresponding improvements put there – instead of being scattered across a range of different packages. This is a common default suggestion for newly proposed packages that do "almost the same" as an existing one.

Of course, it's not a hard rule, one may not want to contribute to an existing package for a wide variety of reasons.

But if the powers that be prefer this package not to be in the registry, that's fine.

At least from my side, there are no specific "powers": literally every github user is free to comment on General PRs.

[NittanyLion]

[noblock] Thanks @aplavin.

[NittanyLion]

[noblock]

Hello @aplavin, I have added documentation to the package and have made a few changes to the code. You can see some examples of the differences in functionality between the two packages at https://nittanylion.github.io/VerifyMacros.jl/dev/

It would be great if you could lift your block, thanks.

[NittanyLion]

[noblock]

requesting manual merge / unblock.