You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Rules are small value objects (`Rule` subtypes) applied to a normalized `NamedTuple`.
11
11
12
12
# Dependencies
@@ -417,7 +417,7 @@ end
417
417
"""
418
418
$(TYPEDSIGNATURES)
419
419
420
-
Trait hook enabling the annular radii rule bundle on fields `:radius_in` and `:radius_ext` (normalized numbers required, finiteness, non-negativity, and the ordering constraint `:radius_in` < `:radius_ext`). It does not indicate the mere existence of radii; it opts in to the annular/coaxial shell geometry checks.
420
+
Trait hook enabling the annular radii rule bundle on fields `:radius_in` and `:radius_ext` (normalized numbers required, finiteness, non‑negativity, and the ordering constraint `:radius_in` < `:radius_ext`). It does **not** indicate the mere existence of radii; it opts in to the annular/coaxial shell geometry checks.
421
421
422
422
# Arguments
423
423
@@ -430,7 +430,7 @@ Trait hook enabling the annular radii rule bundle on fields `:radius_in` and `:r
Trait hook listing optional keyword fields to be merged to positionals in `sanitize`.
486
+
Trait hook listing optional keyword fields considered by `sanitize`.
487
487
488
488
# Arguments
489
489
490
490
- `::Type{T}`: Component type \\[dimensionless\\].
491
491
492
492
# Returns
493
493
494
-
- Tuple of field names that are optional.
494
+
- Tuple of optional keyword field names.
495
495
"""
496
496
keyword_fields(::Type) = ()
497
497
498
498
"""
499
499
$(TYPEDSIGNATURES)
500
500
501
-
Trait hook listing coercive fields (`<:AbstractFloat`) that must be converted to the target type during [`validate!`])(@ref). Defaults to all fields (required and keyword optionals). Overrides should be implemented per type.
501
+
Trait hook listing **coercive** fields: values that participate in numeric promotion and will be converted to the promoted type by the convenience constructor. Defaults to all fields (`required_fields ∪ keyword_fields`). Types may override to exclude integers or categorical fields.
502
502
503
503
# Arguments
504
504
505
505
- `::Type{T}`: Component type \\[dimensionless\\].
506
506
507
507
# Returns
508
508
509
-
- Tuple of field names that are coercive.
509
+
- Tuple of field names that are coerced.
510
510
"""
511
511
coercive_fields(::Type{T}) where {T} = (required_fields(T)..., keyword_fields(T)...)
512
512
@@ -540,7 +540,7 @@ is_radius_input(::Type{T}, x) where {T} = (x isa Number) && !(x isa Complex)
540
540
"""
541
541
$(TYPEDSIGNATURES)
542
542
543
-
Field‑aware acceptance predicate used by `sanitize` to distinguish inner vs. outer radius policies. The default forwards to the scalar predicate [`is_radius_input(::Type{T}, x)`](@ref) when no field‑specific method is defined.
543
+
Field‑aware acceptance predicate used by `sanitize` to distinguish inner vs. outer radius policies. The default forwards to [`is_radius_input(::Type{T}, x)`](@ref) when no field‑specific method is defined.
0 commit comments