Skip to content

Commit

Permalink
improve evaluate docs (#801)
Browse files Browse the repository at this point in the history
  • Loading branch information
jishnub authored Aug 20, 2022
1 parent 309fdae commit 1fc0486
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/docs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -454,8 +454,10 @@ itransform(::Space, ::AbstractVector)
"""
evaluate(coefficients::AbstractVector, sp::Space, x)
Evaluates the expansion at a point `x`.
If `x` is in the domain, then this should return zero.
Evaluates the expansion at a point `x` that lies in `domain(sp)`.
If `x` is not in the domain, the returned value will depend on the space,
and should not be relied upon. See [`extrapolate`](@ref) to evaluate a function
at a value outside the domain.
"""
evaluate(::AbstractVector, ::Space, _)

Expand Down

2 comments on commit 1fc0486

@jishnub
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/66611

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.13.8 -m "<description of version>" 1fc04867865f62567b78fab37ef90af5a7600074
git push origin v0.13.8

Please sign in to comment.