Skip to content

Commit abdecb7

Browse files
authored
Update tocanonical docstring, and remove canonicaldomain (#580)
1 parent 4e93fb6 commit abdecb7

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/Domain.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -103,18 +103,18 @@ issubcomponent(a::Domain,b::Domain) = a in components(b)
103103

104104
##### canoncial
105105
"""
106-
canonicaldomain(d)
107-
108-
returns a domain which we map to for operations. For example,
109-
the canonical domain for an interval [a,b] is [-1,1]
110-
"""
111-
function canonicaldomain end
106+
tocanonical(d, x)
112107
108+
Map the point `x` in `d` to a point in `DomainSets.canonicaldomain(d)`.
113109
114-
"""
115-
tocanonical(d, x)
110+
# Examples
111+
```jldoctest
112+
julia> tocanonical(0..0.5, 0)
113+
-1.0
116114
117-
maps the point `x` in `d` to a point in `canonical(d,x)`
115+
julia> tocanonical(0..0.5, 0.5)
116+
1.0
117+
```
118118
"""
119119
function tocanonical end
120120

0 commit comments

Comments
 (0)