Skip to content

Commit 65ffb4d

Browse files
authored
Fix docstring for Roots module (#404)
1 parent 2e7c255 commit 65ffb4d

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "Roots"
22
uuid = "f2b01f46-fcfa-551c-844a-d8ac1e96c665"
3-
version = "2.0.20"
3+
version = "2.0.21"
44

55
[deps]
66
ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"

src/Roots.jl

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
"""
2-
`Roots`. A package for solving `f(x) = 0` for univariate, scalar functions.
2+
Roots
3+
4+
A package for solving `f(x) = 0` for univariate, scalar functions.
35
46
The basic methods are
57
* [`find_zero`](@ref) for using one of several methods to identify a zero
68
* [`ZeroProblem`](@ref) for solving for a zero using the `CommonSolve` interface
79
* [`find_zeros`](@ref) for heuristically identifying all zeros in a specified interval
10+
11+
# Extended help
12+
13+
$(replace(read(joinpath(@__DIR__, "..", "README.md"), String), "```julia" => "```jldoctest readme"))
814
"""
915
module Roots
1016

@@ -76,14 +82,4 @@ include("find_zeros.jl")
7682
include("simple.jl")
7783
include("alternative_interfaces.jl")
7884

79-
# cf. https://github.com/JuliaDocs/Documenter.jl/pull/1664/files
80-
function _update_module_doc()
81-
path = joinpath(@__DIR__, "..", "README.md")
82-
text = read(path, String)
83-
# The code blocks in the README.md should be julia blocks for the syntax highlighter.
84-
text = replace(text, "```julia" => "```jldoctest readme")
85-
@doc text Roots
86-
end
87-
_update_module_doc()
88-
8985
end

0 commit comments

Comments
 (0)