Skip to content

Commit de019c3

Browse files
committed
Clean up README
1 parent 078515d commit de019c3

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Build Status](https://github.com/MilesCranmer/BaseType.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/MilesCranmer/BaseType.jl/actions/workflows/CI.yml?query=branch%3Amain)
66
[![Aqua](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl)
77

8-
This package defines a function `base_numeric_type` that
8+
This package defines a tiny function `base_numeric_type` that
99
extracts the base numeric type from a possible container type `T`.
1010

1111
- `base_numeric_type(::Type{T}) where {T}`
@@ -26,9 +26,10 @@ For example,
2626
```
2727

2828
Packages should write a method to `base_numeric_type`
29-
the base numeric type of a container
30-
is not the **first parametric type**, which is the default.
29+
when the base numeric type of a container type
30+
is not the first parametric type. Otherwise,
31+
the default method will already be valid.
3132

32-
However, this is not needed for container types
33-
that inherit from `AbstractArray{T}`, where `T`
33+
Furthermore, this is not needed for container types
34+
that inherit from `AbstractArray{T}`, as `T`
3435
will be taken as the base numeric type.

0 commit comments

Comments
 (0)