Skip to content

Commit

Permalink
Improve docstrings in satisfies.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
juliohm committed Jul 20, 2024
1 parent 4fc4fe2 commit 06474d0
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/transforms/satisfies.jl
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ Selects the columns that have scientific type `S`.
# Examples
```julia
import DataScienceTraits as DST
Only(DST.Continuous)
using DataScienceTraits
Only(Continuous)
```
"""
Only(S::Type{<:SciType}) = Satisfies(x -> elscitype(x) <: S)
Expand All @@ -56,8 +57,9 @@ Selects the columns that don't have scientific type `S`.
# Examples
```julia
import DataScienceTraits as DST
Except(DST.Categorical)
using DataScienceTraits
Except(Categorical)
```
"""
Except(S::Type{<:SciType}) = Satisfies(x -> !(elscitype(x) <: S))

0 comments on commit 06474d0

Please sign in to comment.