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

Add mention of Aqua and JET #94199

Merged
merged 1 commit into from
Oct 29, 2023
Merged

Add mention of Aqua and JET #94199

merged 1 commit into from
Oct 29, 2023

Conversation

gdalle
Copy link
Contributor

@gdalle gdalle commented Oct 27, 2023

Point users to Aqua and JET in the section about tests

@PallHaraldsson
Copy link
Contributor

PallHaraldsson commented Oct 27, 2023

I just learned of: https://github.com/crate-ci/typos

that has added Julia supported, and is now used by Julia CI, so maybe point it out to users, if some user friendly way to use it:
JuliaLang/julia#51704

@PallHaraldsson
Copy link
Contributor

Does it help to add: "It's helpful if your code is type-stable; to use @code_warntype for your code to ensure (for speed-critical code, most code isn't and it's not strictly needed for such code).

I think this advice may be redundant with either or both of the suggested packages. With the macro you at least don't need to install a package, but also while they automate, I think they look at all your code, and people may get overwhelmed. So while helpful, not all code needs to be perfect/type-stable, and you may know where best to check. Type-unstable isn't wrong, so maybe imperfect isn't the right word for it?

[I recently saw a user on discource wanting his code type-stable (non-allocating), it strictly wasn't needed, but he wanted his code-dependency to be type-stable, since his dependent was, to not make it no longer so. Maybe packages that are, should be marked, would that be possible? To be useful, dependencies would need to be recursively checked...]

@giordano giordano merged commit d2279af into JuliaRegistries:master Oct 29, 2023
10 checks passed
@gdalle
Copy link
Contributor Author

gdalle commented Oct 30, 2023

I don't think expecting type-stability from registered packages is quite in the same category as good tests and documentation. But we can discuss this on another issue, cause apparently my one sentence was deemed mergeable ;)

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

Successfully merging this pull request may close these issues.

3 participants