Docs: check that exports are documented, with check for regression/improvement #55267

IanButterworth · 2024-07-26T14:55:43Z

@mortenpi and I were talking about checkdocs = :public being the right option, but that does not exist yet.

mortenpi · 2024-07-26T14:57:28Z

IanButterworth · 2024-07-26T15:27:11Z

Documenter reports all of these for checkdocs = :exported

  | 2024-07-26 11:16:37 EDT | ┌ Error: 298 docstrings not included in the manual:
  | 2024-07-26 11:16:37 EDT | │
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.triplet :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.HashArrayMappedTries.HAMT
  | 2024-07-26 11:16:37 EDT | │     Base.Sys.which :: Tuple{String}
  | 2024-07-26 11:16:37 EDT | │     Base.Sys.CPU_NAME
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IXOTH
  | 2024-07-26 11:16:37 EDT | │     Base.:⊇
  | 2024-07-26 11:16:37 EDT | │     Base.:⊇ :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.Sort.DEFAULT_UNSTABLE
  | 2024-07-26 11:16:37 EDT | │     SHA.SHA
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.download_artifact :: Union{Tuple{Base.SHA1, String}, Tuple{Base.SHA1, String, Union{Nothing, String}}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_LARGEFILE
  | 2024-07-26 11:16:37 EDT | │     Dates.Jan
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.archive_artifact :: Tuple{Base.SHA1, String}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.StatStruct
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_NOFOLLOW
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_ASYNC
  | 2024-07-26 11:16:37 EDT | │     Dates.Wed
  | 2024-07-26 11:16:37 EDT | │     Dates.DatePeriod
  | 2024-07-26 11:16:37 EDT | │     Pkg.RegistrySpec
  | 2024-07-26 11:16:37 EDT | │     Dates.Mon
  | 2024-07-26 11:16:37 EDT | │     Dates.Year :: Tuple{Date}
  | 2024-07-26 11:16:37 EDT | │     Dates.Year :: Tuple{DateTime}
  | 2024-07-26 11:16:37 EDT | │     Dates.Year :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.@info
  | 2024-07-26 11:16:37 EDT | │     Base.findfirst :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}}
  | 2024-07-26 11:16:37 EDT | │     Base.findfirst :: Tuple{AbstractChar, AbstractString}
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.unbind_artifact! :: Tuple{String, String}
  | 2024-07-26 11:16:37 EDT | │     Dates.March
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Timings
  | 2024-07-26 11:16:37 EDT | │     Base.any :: Tuple{Any, Any}
  | 2024-07-26 11:16:37 EDT | │     Base.any :: Tuple{AbstractArray}
  | 2024-07-26 11:16:37 EDT | │     Base.any :: Tuple{Function, AbstractArray}
  | 2024-07-26 11:16:37 EDT | │     Base.BitVector :: Tuple{Tuple{Vararg{Bool}}}
  | 2024-07-26 11:16:37 EDT | │     Dates.Sunday
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.Ordering
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.arch :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.libstdcxx_version :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Dates.Minute :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Dates.Minute :: Tuple{Time}
  | 2024-07-26 11:16:37 EDT | │     Pkg.PackageSpec
  | 2024-07-26 11:16:37 EDT | │     Base.all :: Tuple{Any, Any}
  | 2024-07-26 11:16:37 EDT | │     Base.all :: Tuple{AbstractArray}
  | 2024-07-26 11:16:37 EDT | │     Base.all :: Tuple{Function, AbstractArray}
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.SyntaxNode
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.head :: Tuple{Base.JuliaSyntax.TreeNode{<:Base.JuliaSyntax.AbstractSyntaxData}}
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.kind :: Tuple{Base.JuliaSyntax.Kind}
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.detect_libgfortran_version :: Tuple{}
  | 2024-07-26 11:16:37 EDT | │     Dates.Tuesday
  | 2024-07-26 11:16:37 EDT | │     Pkg.PackageMode
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.platforms_match :: Tuple{Base.BinaryPlatforms.AbstractPlatform, Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_NOATIME
  | 2024-07-26 11:16:37 EDT | │     Pkg.BinaryPlatforms.valid_dl_path :: Tuple{AbstractString, Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_WRONLY
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.detect_libstdcxx_version :: Union{Tuple{}, Tuple{Int64}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_TRUNC
  | 2024-07-26 11:16:37 EDT | │     Base.MathConstants.γ
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.SimpleLogger
  | 2024-07-26 11:16:37 EDT | │     Core.@cmd :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Dates.October
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.mktemp :: Union{Tuple{Function}, Tuple{Function, AbstractString}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.mktemp :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.Math.fourthroot :: Tuple{Number}
  | 2024-07-26 11:16:37 EDT | │     Base.bitreverse :: Tuple{Union{Int128, Int16, Int32, Int64, Int8, UInt128, UInt16, UInt32, UInt64, UInt8}}
  | 2024-07-26 11:16:37 EDT | │     Base.:⊆
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_RDONLY
  | 2024-07-26 11:16:37 EDT | │     Dates.Microsecond :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     InteractiveUtils.InteractiveUtils
  | 2024-07-26 11:16:37 EDT | │     Dates.Sun
  | 2024-07-26 11:16:37 EDT | │     Base.float :: Union{Tuple{Type{T}}, Tuple{T}} where T<:Number
  | 2024-07-26 11:16:37 EDT | │     Pkg.PlatformEngines.verify :: Tuple{AbstractString, AbstractString}
  | 2024-07-26 11:16:37 EDT | │     Base.Sys.JIT
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_DSYNC
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.Tokenize.tokenize :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.which :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.which :: Tuple{Module, Symbol}
  | 2024-07-26 11:16:37 EDT | │     Dates.Oct
  | 2024-07-26 11:16:37 EDT | │     CRC32c.CRC32c
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_DIRECT
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.CPUID.cpu_isa
  | 2024-07-26 11:16:37 EDT | │     Dates.Jul
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.libc :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_SYNC
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.Platform
  | 2024-07-26 11:16:37 EDT | │     Dates.Quarter :: Tuple{Date}
  | 2024-07-26 11:16:37 EDT | │     Dates.Quarter :: Tuple{DateTime}
  | 2024-07-26 11:16:37 EDT | │     Dates.Quarter :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Dates.Feb
  | 2024-07-26 11:16:37 EDT | │     LinearAlgebra.LinearAlgebra
  | 2024-07-26 11:16:37 EDT | │     Pkg.Resolve.sanity_check :: Union{Tuple{Pkg.Resolve.Graph}, Tuple{Pkg.Resolve.Graph, Set{UUID}}, Tuple{Pkg.Resolve.Graph, Set{UUID}, Bool}}
  | 2024-07-26 11:16:37 EDT | │     Base.mapreduce :: Tuple{Any, Any, Union{Base.AbstractBroadcasted, AbstractArray}}
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.NullLogger
  | 2024-07-26 11:16:37 EDT | │     Dates.Mar
  | 2024-07-26 11:16:37 EDT | │     Dates.April
  | 2024-07-26 11:16:37 EDT | │     Base.:⊉
  | 2024-07-26 11:16:37 EDT | │     Base.:⊉ :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IRWXG
  | 2024-07-26 11:16:37 EDT | │     Dates.September
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.AbstractLogger
  | 2024-07-26 11:16:37 EDT | │     Dates.Dec
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IWUSR
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.ReverseOrdering
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.RTLD_NOLOAD
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.ord :: Union{Tuple{Any, Any, Nothing}, Tuple{Any, Any, Nothing, Core.Compiler.Order.Ordering}}
  | 2024-07-26 11:16:37 EDT | │     Dates.Aug
  | 2024-07-26 11:16:37 EDT | │     Base.TOML
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_RDWR
  | 2024-07-26 11:16:37 EDT | │     SparseArrays.fkeep! :: Union{Tuple{F}, Tuple{F, SparseArrays.AbstractSparseMatrixCSC}} where F<:Function
  | 2024-07-26 11:16:37 EDT | │     Dates.January
  | 2024-07-26 11:16:37 EDT | │     Dates.May
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_DIRECTORY
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IRWXU
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.platform_name :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.global_logger :: Tuple{}
  | 2024-07-26 11:16:37 EDT | │     Dates.February
  | 2024-07-26 11:16:37 EDT | │     Statistics.Statistics
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_FSYNC
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.tokenize :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     LinearAlgebra.BLAS.geru!
  | 2024-07-26 11:16:37 EDT | │     Base.Sort.SMALL_ALGORITHM
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.parse_dl_name_version :: Tuple{String, String}
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.wordsize :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     DelimitedFiles.DelimitedFiles
  | 2024-07-26 11:16:37 EDT | │     Dates.Fri
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.RTLD_LOCAL
  | 2024-07-26 11:16:37 EDT | │     Dates.Hour :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Dates.Hour :: Tuple{Time}
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.Perm
  | 2024-07-26 11:16:37 EDT | │     Dates.Apr
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IWOTH
  | 2024-07-26 11:16:37 EDT | │     Tar.Tar
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.os_version :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.Experimental
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_APPEND
  | 2024-07-26 11:16:37 EDT | │     Dates.Jun
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.Forward
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.SourceFile
  | 2024-07-26 11:16:37 EDT | │     SparseArrays.SparseArrays
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.RTLD_NODELETE
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IWGRP
  | 2024-07-26 11:16:37 EDT | │     TOML.TOML
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.LazyLibraryPath
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.@logmsg
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.RTLD_GLOBAL
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.parseatom :: Union{Tuple{T}, Tuple{Type{T}, AbstractString}} where T
  | 2024-07-26 11:16:37 EDT | │     UUIDs.UUIDs
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_EXCL
  | 2024-07-26 11:16:37 EDT | │     Base.findprev :: Tuple{Any, Any}
  | 2024-07-26 11:16:37 EDT | │     Base.findprev :: Tuple{AbstractChar, AbstractString, Integer}
  | 2024-07-26 11:16:37 EDT | │     Base.findprev :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}, Integer}
  | 2024-07-26 11:16:37 EDT | │     Base.findprev :: Tuple{Function, Any, Any}
  | 2024-07-26 11:16:37 EDT | │     InteractiveUtils.edit :: Union{Tuple{AbstractString}, Tuple{AbstractString, Integer}, Tuple{AbstractString, Integer, Integer}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_PATH
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IRUSR
  | 2024-07-26 11:16:37 EDT | │     Base.Docs.doc
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.@debug
  | 2024-07-26 11:16:37 EDT | │     Dates.July
  | 2024-07-26 11:16:37 EDT | │     LibGit2.LibGit2
  | 2024-07-26 11:16:37 EDT | │     Base.AbstractSlices
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.untokenize :: Tuple{Base.JuliaSyntax.Kind}
  | 2024-07-26 11:16:37 EDT | │     Dates.Thu
  | 2024-07-26 11:16:37 EDT | │     Dates.Month :: Tuple{Date}
  | 2024-07-26 11:16:37 EDT | │     Dates.Month :: Tuple{DateTime}
  | 2024-07-26 11:16:37 EDT | │     Dates.Month :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.reverse :: Union{Tuple{AbstractVector, Integer}, Tuple{AbstractVector, Integer, Integer}}
  | 2024-07-26 11:16:37 EDT | │     Base.reverse :: Tuple{AbstractArray}
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.verify_artifact :: Tuple{Base.SHA1}
  | 2024-07-26 11:16:37 EDT | │     Base.:≉ :: Tuple
  | 2024-07-26 11:16:37 EDT | │     Dates.Monday
  | 2024-07-26 11:16:37 EDT | │     Test.Test
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.@K_str :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.complex :: Union{Tuple{Type{T}}, Tuple{T}} where T<:Real
  | 2024-07-26 11:16:37 EDT | │     FileWatching.FileWatching
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.cxxstring_abi :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Dates.November
  | 2024-07-26 11:16:37 EDT | │     Dates.December
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_TMPFILE
  | 2024-07-26 11:16:37 EDT | │     StyledStrings.StyledMarkup
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IROTH
  | 2024-07-26 11:16:37 EDT | │     Dates.Sat
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.parsestmt :: Union{Tuple{T}, Tuple{Type{T}, AbstractString}} where T
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.RTLD_DEEPBIND
  | 2024-07-26 11:16:37 EDT | │     Dates.Saturday
  | 2024-07-26 11:16:37 EDT | │     Base.AbstractMatch
  | 2024-07-26 11:16:37 EDT | │     Base.Rounding.setrounding :: Union{Tuple{T}, Tuple{Function, Type{T}, RoundingMode}} where T
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.ensure_artifact_installed :: Tuple{String, String}
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.remove_artifact :: Tuple{Base.SHA1}
  | 2024-07-26 11:16:37 EDT | │     Sockets.join_multicast_group :: Union{Tuple{UDPSocket, String}, Tuple{UDPSocket, String, Union{Nothing, String}}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.mktempdir :: Union{Tuple{}, Tuple{AbstractString}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.mktempdir :: Union{Tuple{Function}, Tuple{Function, AbstractString}}
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.select_platform :: Union{Tuple{Dict}, Tuple{Dict, Base.BinaryPlatforms.AbstractPlatform}}
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.os :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.Lt
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_CLOEXEC
  | 2024-07-26 11:16:37 EDT | │     Base.MathConstants.φ
  | 2024-07-26 11:16:37 EDT | │     Sockets.leave_multicast_group :: Union{Tuple{UDPSocket, String}, Tuple{UDPSocket, String, Union{Nothing, String}}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_SHORT_LIVED
  | 2024-07-26 11:16:37 EDT | │     Base.Meta.replace_sourceloc! :: Tuple{Any, Any}
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.LazyLibrary
  | 2024-07-26 11:16:37 EDT | │     Base.:⊋
  | 2024-07-26 11:16:37 EDT | │     Base.:⊋ :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.detect_cxxstring_abi :: Tuple{}
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.with_logger :: Tuple{Function, Base.CoreLogging.AbstractLogger}
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.@error
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.parseall :: Union{Tuple{T}, Tuple{Type{T}, AbstractString}} where T
  | 2024-07-26 11:16:37 EDT | │     Markdown.Markdown
  | 2024-07-26 11:16:37 EDT | │     Profile.Profile
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.By
  | 2024-07-26 11:16:37 EDT | │     Dates.Tue
  | 2024-07-26 11:16:37 EDT | │     Base.count! :: Tuple{AbstractArray, Union{Base.AbstractBroadcasted, AbstractArray}}
  | 2024-07-26 11:16:37 EDT | │     Base.:∌
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.LogLevel
  | 2024-07-26 11:16:37 EDT | │     Base.:=>
  | 2024-07-26 11:16:37 EDT | │     REPL.REPL
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.lt :: Tuple{Core.Compiler.Order.ForwardOrdering, Any, Any}
  | 2024-07-26 11:16:37 EDT | │     UUIDs.uuid7 :: Union{Tuple{}, Tuple{AbstractRNG}}
  | 2024-07-26 11:16:37 EDT | │     Base.__has_internal_change :: Tuple{VersionNumber, Symbol}
  | 2024-07-26 11:16:37 EDT | │     Base.findlast :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}}
  | 2024-07-26 11:16:37 EDT | │     Base.JuliaSyntax.Token
  | 2024-07-26 11:16:37 EDT | │     Dates.Nanosecond :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.Sys.cpu_info :: Tuple{}
  | 2024-07-26 11:16:37 EDT | │     Base.@main :: Tuple
  | 2024-07-26 11:16:37 EDT | │     Printf.Printf
  | 2024-07-26 11:16:37 EDT | │     Dates.Sep
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.bind_artifact! :: Tuple{String, String, Base.SHA1}
  | 2024-07-26 11:16:37 EDT | │     Future.Future
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_NONBLOCK
  | 2024-07-26 11:16:37 EDT | │     Dates.Wednesday
  | 2024-07-26 11:16:37 EDT | │     Dates.June
  | 2024-07-26 11:16:37 EDT | │     Dates.Second :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Dates.Second :: Tuple{Time}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_NDELAY
  | 2024-07-26 11:16:37 EDT | │     Base.findall :: Tuple{AbstractChar, AbstractString}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IXGRP
  | 2024-07-26 11:16:37 EDT | │     Base.AbstractPattern
  | 2024-07-26 11:16:37 EDT | │     Pkg.Resolve.resolve :: Tuple{Pkg.Resolve.Graph}
  | 2024-07-26 11:16:37 EDT | │     LinearAlgebra.inertia :: Union{Tuple{BunchKaufman{TS}}, Tuple{TS}, Tuple{TR}} where {TR<:Union{AbstractFloat, Rational}, TS<:Union{Complex{TR}, TR}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_SEQUENTIAL
  | 2024-07-26 11:16:37 EDT | │     Base.:∋ :: Tuple{Any, Any}
  | 2024-07-26 11:16:37 EDT | │     Base.:∋ :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Dates.Week :: Tuple{Date}
  | 2024-07-26 11:16:37 EDT | │     Dates.Week :: Tuple{DateTime}
  | 2024-07-26 11:16:37 EDT | │     Dates.Week :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IRGRP
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.HostPlatform :: Tuple{}
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.HostPlatform :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IRWXO
  | 2024-07-26 11:16:37 EDT | │     Base.MathConstants
  | 2024-07-26 11:16:37 EDT | │     Base.MathConstants.e
  | 2024-07-26 11:16:37 EDT | │     Dates.August
  | 2024-07-26 11:16:37 EDT | │     Dates.Thursday
  | 2024-07-26 11:16:37 EDT | │     Pkg.UpgradeLevel
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.call_abi :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Mmap.Mmap
  | 2024-07-26 11:16:37 EDT | │     Base.Sort.DEFAULT_STABLE
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.libgfortran_version :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
  | 2024-07-26 11:16:37 EDT | │     Pkg.Artifacts.create_artifact :: Tuple{Function}
  | 2024-07-26 11:16:37 EDT | │     Base.Sys.cpu_summary :: Union{Tuple{}, Tuple{IO}, Tuple{IO, AbstractVector{Base.Sys.CPUinfo}}}
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.RTLD_FIRST
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.BundledLazyLibraryPath :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Pkg.BinaryPlatforms.platform_key_abi :: Tuple{}
  | 2024-07-26 11:16:37 EDT | │     Dates.Nov
  | 2024-07-26 11:16:37 EDT | │     Base.MathConstants.π
  | 2024-07-26 11:16:37 EDT | │     Dates.Millisecond :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Dates.Millisecond :: Tuple{Time}
  | 2024-07-26 11:16:37 EDT | │     Base.:* :: Tuple{Union{Regex, AbstractChar, AbstractString}, Vararg{Union{Regex, AbstractChar, AbstractString}}}
  | 2024-07-26 11:16:37 EDT | │     Dates.Dates
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.current_logger :: Tuple{}
  | 2024-07-26 11:16:37 EDT | │     Dates.Day :: Tuple{Date}
  | 2024-07-26 11:16:37 EDT | │     Dates.Day :: Tuple{DateTime}
  | 2024-07-26 11:16:37 EDT | │     Dates.Day :: Tuple{Any}
  | 2024-07-26 11:16:37 EDT | │     Downloads.Downloads
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_CREAT
  | 2024-07-26 11:16:37 EDT | │     Dates.TimePeriod
  | 2024-07-26 11:16:37 EDT | │     Base.ncodeunits :: Tuple{Char}
  | 2024-07-26 11:16:37 EDT | │     Artifacts.Artifacts
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.S_IXUSR
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.disable_logging :: Tuple{Base.CoreLogging.LogLevel}
  | 2024-07-26 11:16:37 EDT | │     Core.Compiler.Order.Reverse
  | 2024-07-26 11:16:37 EDT | │     LinearAlgebra.copytrito! :: Tuple{AbstractMatrix, AbstractMatrix, AbstractChar}
  | 2024-07-26 11:16:37 EDT | │     Base.findnext :: Tuple{Any, Any}
  | 2024-07-26 11:16:37 EDT | │     Base.findnext :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}, Integer}
  | 2024-07-26 11:16:37 EDT | │     Base.findnext :: Tuple{Function, Any, Any}
  | 2024-07-26 11:16:37 EDT | │     Pkg.PlatformEngines.download_verify_unpack :: Tuple{AbstractString, Union{Nothing, AbstractString}, AbstractString}
  | 2024-07-26 11:16:37 EDT | │     Pkg.PlatformEngines.package :: Tuple{AbstractString, AbstractString}
  | 2024-07-26 11:16:37 EDT | │     Downloads.default_downloader! :: Union{Tuple{}, Tuple{Union{Nothing, Downloader}}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_TEMPORARY
  | 2024-07-26 11:16:37 EDT | │     Base.Returns
  | 2024-07-26 11:16:37 EDT | │     Dates.Friday
  | 2024-07-26 11:16:37 EDT | │     Base.BinaryPlatforms.platform_dlext :: Union{Tuple{}, Tuple{Base.BinaryPlatforms.AbstractPlatform}}
  | 2024-07-26 11:16:37 EDT | │     Base.CoreLogging.@warn
  | 2024-07-26 11:16:37 EDT | │     Base.Libc.Libdl.RTLD_LAZY
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_RSYNC
  | 2024-07-26 11:16:37 EDT | │     Serialization.Serialization
  | 2024-07-26 11:16:37 EDT | │     SharedArrays.SharedArrays
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_RANDOM
  | 2024-07-26 11:16:37 EDT | │     InteractiveUtils.peakflops :: Union{Tuple{}, Tuple{Integer}}
  | 2024-07-26 11:16:37 EDT | │     Base.Filesystem.JL_O_NOCTTY
  | 2024-07-26 11:16:37 EDT | │
  | 2024-07-26 11:16:37 EDT | │ These are docstrings in the checked modules (configured with the modules keyword)
  | 2024-07-26 11:16:37 EDT | │ that are not included in canonical @docs or @autodocs blocks.
  | 2024-07-26 11:16:37 EDT | └ @ Documenter /Users/julia/.julia/scratchspaces/a66863c6-20e8-4ff4-8a62-49f30b1f605e/agent-cache/default-honeycrisp-HL2F7YQ3XH.0/build/default-honeycrisp-HL2F7YQ3XH-0/julialang/julia-master/doc/deps/packages/Documenter/pA5Sa/src/utilities/utilities.jl:44

IanButterworth · 2024-07-26T15:42:42Z

Tracking issue #19529

IanButterworth · 2024-07-26T18:10:22Z

Reopening with warnonly = :missing_docs

IanButterworth · 2024-07-26T19:28:40Z

Now checks if the number increases or reduces with appropriate messages for each

doc/make.jl

IanButterworth · 2024-09-24T00:47:34Z

@mortenpi even for the single online docs build the number of missing docs isn't stable.. for the same base commit I've seen 298 299 300 301 missing docstrings reported.

Because of that instead of erroring I've made them elevated log messages in buildkite.

https://buildkite.com/julialang/julia-master/builds/40201#annotation-missing-docs

mortenpi · 2024-10-02T04:23:57Z

That seems like a good workaround for now. I think we should merge this and iterate in follow-up PRs.

IanButterworth · 2024-10-02T12:51:11Z

I'm hesitating to show any sort of instruction while the number is unstable. People will learn to ignore it, and then when the reason for the instability is fixed it will still be ignored.

ViralBShah · 2025-09-13T17:40:41Z

Should we get this in?

DilumAluthge · 2025-09-13T17:46:26Z

It would be great to get this in.

I don't know the details of whether it's ready to merge, from a technical point of view.

IanButterworth · 2025-09-13T20:37:17Z

Last time I tried it was returning different numbers each time for the same commit. Seems somehow that the docs system isn't repeatable enough. Might be worth just trying again.

IanButterworth · 2025-10-25T02:50:11Z

Trying to revive this. Documenter now has :public

IanButterworth · 2025-10-25T10:47:05Z

@mortenpi the number still isn't stable. In the last 3 runs on the same commit it was 397, 398, 399. Do we have any idea why it's not stable?

doc/make.jl

IanButterworth added docs This change adds or pertains to documentation docsystem The documentation building system labels Jul 26, 2024

IanButterworth force-pushed the ib/checkdocs branch from e604ebf to 955006b Compare July 26, 2024 14:55

IanButterworth mentioned this pull request Jul 26, 2024

Include all public docstrings in the manual #19529

Open

IanButterworth closed this Jul 26, 2024

IanButterworth deleted the ib/checkdocs branch July 26, 2024 16:01

IanButterworth restored the ib/checkdocs branch July 26, 2024 18:08

IanButterworth reopened this Jul 26, 2024

IanButterworth changed the title ~~Docs: check that all exports are documented~~ Docs: check that all exports are documented, but warn only Jul 26, 2024

IanButterworth force-pushed the ib/checkdocs branch from 8defce8 to b3d7f06 Compare July 26, 2024 19:27

IanButterworth changed the title ~~Docs: check that all exports are documented, but warn only~~ Docs: check that exports are documented, with check for regression/improvement Jul 26, 2024

IanButterworth force-pushed the ib/checkdocs branch 2 times, most recently from eebe2b9 to 7a59bd7 Compare July 27, 2024 16:08

mortenpi reviewed Jul 29, 2024

View reviewed changes

doc/make.jl Outdated Show resolved Hide resolved

IanButterworth force-pushed the ib/checkdocs branch from 7a59bd7 to ccf7de9 Compare September 23, 2024 20:31

IanButterworth requested a review from mortenpi September 23, 2024 20:58

IanButterworth force-pushed the ib/checkdocs branch from feaf64e to 3a9bb3e Compare October 25, 2025 02:49

IanButterworth force-pushed the ib/checkdocs branch from 3a9bb3e to 5262fb5 Compare October 25, 2025 03:56

check that all public objects are documented

a0e1255

IanButterworth force-pushed the ib/checkdocs branch from 5262fb5 to a0e1255 Compare October 25, 2025 04:39

IanButterworth mentioned this pull request Oct 25, 2025

Make missingbindings and allbindings deterministic JuliaDocs/Documenter.jl#2781

Open

IanButterworth added 3 commits October 25, 2025 07:34

sort to help stability

85f7211

try JuliaDocs/Documenter.jl#2781

9ced006

fix known_missing_from_manual

e584a52

IanButterworth force-pushed the ib/checkdocs branch from a6eb1b2 to e584a52 Compare October 25, 2025 12:18

IanButterworth added 6 commits October 25, 2025 08:25

exclude Pkg from the missingdocs search

94b88e0

up Documenter

1ad6606

fix

f5c65d9

up Documenter

570f87a

up Documenter

d6236bc

up Documenter

aeb960a

IanButterworth commented Oct 26, 2025

View reviewed changes

doc/make.jl Outdated Show resolved Hide resolved

Update make.jl

aecdece

Uh oh!

Uh oh!

Docs: check that exports are documented, with check for regression/improvement #55267

Are you sure you want to change the base?

Docs: check that exports are documented, with check for regression/improvement #55267

Conversation

IanButterworth commented Jul 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mortenpi commented Jul 26, 2024

Uh oh!

IanButterworth commented Jul 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IanButterworth commented Jul 26, 2024

Uh oh!

IanButterworth commented Jul 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IanButterworth commented Jul 26, 2024

Uh oh!

Uh oh!

IanButterworth commented Sep 24, 2024

Uh oh!

mortenpi commented Oct 2, 2024

Uh oh!

IanButterworth commented Oct 2, 2024

Uh oh!

ViralBShah commented Sep 13, 2025

Uh oh!

DilumAluthge commented Sep 13, 2025

Uh oh!

IanButterworth commented Sep 13, 2025

Uh oh!

IanButterworth commented Oct 25, 2025

Uh oh!

IanButterworth commented Oct 25, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

IanButterworth commented Jul 26, 2024 •

edited

Loading

IanButterworth commented Jul 26, 2024 •

edited

Loading

IanButterworth commented Jul 26, 2024 •

edited

Loading