Unitful-like API shims - #199
Open
MilesCranmerBot wants to merge 17 commits into
Open
Conversation
Add common Unitful-shaped helpers (unit/dimensions/isunitless/upreferred/uparse). Co-authored-by: Miles Cranmer <miles.cranmer@gmail.com>
Contributor
Benchmark Results (Julia v1.10)Time benchmarks
Memory benchmarks
|
Contributor
Benchmark Results (Julia v1)Time benchmarks
Memory benchmarks
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #199 +/- ##
==========================================
- Coverage 99.14% 99.02% -0.13%
==========================================
Files 21 23 +2
Lines 1292 1327 +35
==========================================
+ Hits 1281 1314 +33
- Misses 11 13 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Add missing docstrings and adjust Documenter filters so the Documentation job passes.
Unitful exports (singular); remove the alias/export and update docs/tests accordingly.
Drop dimensions alias; make uparse parse unit strings only; stop exporting NoUnits/dimensionless sentinels.
Give isdimensionless its own docstring (alias of isunitless) to avoid confusing copied docs.
Move the Unitful-like shim assertions next to existing unit/uparse/ustrip coverage.
Member
|
@codex review |
MilesCranmer
approved these changes
Feb 15, 2026
MilesCranmer
left a comment
MilesCranmer
left a comment
Member
There was a problem hiding this comment.
I think this is looking good. Will be useful for improving API compatibility with Unitful
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4ffb5f868c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Co-authored-by: Miles Cranmer <miles.cranmer@gmail.com>
Contributor
Author
|
Fixed: simplified |
MilesCranmer
approved these changes
Mar 8, 2026
Co-authored-by: Miles Cranmer <miles.cranmer@gmail.com>
Contributor
Author
|
Agreed — matching Unitful: I made isunitless/isdimensionless scalar-only (arrays now throw MethodError; use broadcasting: isunitless.(x)). Pushed in commit 5e3592a to branch unitful-api-compat. |
MilesCranmer
reviewed
Mar 8, 2026
Comment on lines
+434
to
+439
|
|
||
| !!! note | ||
| Like Unitful.jl, `isunitless` is only defined for scalars. For arrays, use broadcasting: | ||
| `isunitless.(x)`. | ||
|
|
||
| See also [`isdimensionless`](@ref). |
Co-authored-by: Miles Cranmer <miles.cranmer@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a small set of Unitful-shaped API shims (wrappers/aliases) to ease downstream compatibility while keeping DynamicQuantities semantics intact.
Included:
Tests: local Pkg.test() passed.