warnonly in docs for undocumented functions

PierreBarrat · Feb 22, 2024 · 09c4d38 · 09c4d38
1 parent 707356f
commit 09c4d38
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/make.jl b/docs/make.jl
@@ -3,6 +3,7 @@ using Documenter
 
 Documenter.makedocs(;
 	source = "src",
+    warnonly = [:missing_docs,],
 	clean = true,
 	doctest = true,
 	modules = Module[TreeKnit],

diff --git a/src/objects.jl b/src/objects.jl
@@ -56,7 +56,7 @@ end
 """
 	function OptArgs(K::Int; method=:none, kwargs...)
 
-OptArgs constructor will default to :better_trees method if K>2, :better_MCCs if K==2.
+OptArgs constructor will default to `:better_trees` method if `K>2`, `:better_MCCs` if `K==2`.
 """
 function OptArgs(K::Int; method=:none, kwargs...)
 	kwargs_dict = Dict(kwargs)