Skip to content

Conversation

@IanButterworth
Copy link
Member

@IanButterworth IanButterworth commented Oct 26, 2025

These docstrings already exist for public objects, but are missing from the docs. doctest reports them.

This PR isn't complete, but I'm opening to get a WIP count.

Also its done with Claude, so might need some decision making. Some might not make sense for the docs.

┌ Warning: 354 docstrings not included in the manual:
│ 
│     Dates.Apr
│     Dates.isoyear :: Tuple{DateTime}
│     Base.JuliaSyntax.highlight :: Tuple{IO, Any}
│     Base.Filesystem.JL_O_NONBLOCK
│     Base.Sys.JIT
│     Base.BinaryPlatforms.Platform
│     Base.CodeUnits
│     Base.JuliaSyntax.source_line :: Tuple{Any}
│     Profile.take_page_profile :: Tuple{IOStream}
│     Base.JuliaSyntax.has_flags :: Tuple{UInt16, Any}
│     Base.BitVector :: Tuple{Tuple{Vararg{Bool}}}
│     Base.Filesystem.S_IRWXU
│     Base.which :: Tuple{Any}
│     Base.which :: Tuple{Module, Symbol}
│     SHA.SHA
│     Dates.May
│     Base.Filesystem.S_IRWXO
│     InteractiveUtils.@activate :: Tuple{Any}
│     Base.JuliaSyntax.source_line_range :: Tuple{Base.JuliaSyntax.SourceFile, Integer}
│     Core.@cmd :: Tuple{String}
│     Base.Filesystem.JL_O_APPEND
│     Base.Libc.Libdl.RTLD_NODELETE
│     Base.count! :: Tuple{AbstractArray, Union{Base.AbstractBroadcasted, AbstractArray}}
│     Base.JuliaSyntax.byte_range
│     Markdown.Markdown
│     Base.:∋ :: Tuple{Any, Any}
│     Base.:∋ :: Tuple{Any}
│     Statistics.Statistics
│     Base.:=>
│     Base.JuliaSyntax.is_prefix_op_call :: Tuple{Any}
│     Base.Iterators.nth :: Tuple{Integer}
│     Base.Iterators.nth :: Tuple{Any, Integer}
│     Mmap.Mmap
│     Base.Rounding.setrounding :: Union{Tuple{T}, Tuple{Function, Type{T}, RoundingMode}} where T
│     Base.Libc.Libdl.RTLD_GLOBAL
│     Base.MathConstants.π
│     Base.BinaryPlatforms.cxxstring_abi :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.setuid
│     Dates.Dec
│     Base.Filesystem.JL_O_WRONLY
│     Base.Filesystem.S_IWOTH
│     Dates.February
│     Base.float :: Tuple{AbstractArray{<:AbstractFloat}}
│     Base.float :: Union{Tuple{Type{T}}, Tuple{T}} where T<:Number
│     Base.JuliaSyntax.last_byte :: Tuple{Any}
│     Base.Filesystem.JL_O_CLOEXEC
│     Base.any :: Tuple{Any, Any}
│     Base.any :: Tuple{AbstractArray}
│     Base.any :: Tuple{Function, AbstractArray}
│     Base.pipeline :: Tuple{Base.AbstractCmd, Pair{<:Integer, <:Union{RawFD, Base.FileRedirect, Base.IOServer, IO}}}
│     Base.JuliaSyntax.flags :: Tuple{Base.JuliaSyntax.SyntaxHead}
│     Base.Sys.CPU_NAME
│     StyledStrings.StyledMarkup
│     Base.remove_linenums! :: Tuple{Any}
│     LinearAlgebra.symmetric :: Union{Tuple{AbstractMatrix}, Tuple{AbstractMatrix, Symbol}}
│     LinearAlgebra.AbstractTriangular
│     Base.Libc.Libdl.RTLD_FIRST
│     Base.Filesystem.JL_O_RANDOM
│     Base.Filesystem.S_IROTH
│     Dates.Quarter :: Tuple{DateTime}
│     Dates.Quarter :: Tuple{Any}
│     Dates.Quarter :: Tuple{Date}
│     Base.JuliaSyntax.sourcefile
│     Base.JuliaSyntax.numchildren :: Tuple{Base.JuliaSyntax.TreeNode}
│     SharedArrays.SharedArrays
│     UUIDs.UUIDs
│     Dates.November
│     Dates.March
│     Dates.December
│     Base.Filesystem.JL_O_LARGEFILE
│     Future.Future
│     Dates.Oct
│     Sockets.leave_multicast_group :: Union{Tuple{UDPSocket, String}, Tuple{UDPSocket, String, Union{Nothing, String}}}
│     Base.Filesystem.S_IRUSR
│     Dates.Tuesday
│     Base.BinaryPlatforms.platforms_match :: Tuple{Base.BinaryPlatforms.AbstractPlatform, Base.BinaryPlatforms.AbstractPlatform}
│     Base.JuliaSyntax.is_infix_op_call :: Tuple{Any}
│     Base.BinaryPlatforms.HostPlatform :: Tuple{}
│     Base.BinaryPlatforms.HostPlatform :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.Filesystem.JL_O_RDONLY
│     Dates.Wednesday
│     InteractiveUtils.edit :: Union{Tuple{AbstractString}, Tuple{AbstractString, Integer}, Tuple{AbstractString, Integer, Integer}}
│     Dates.Sun
│     Base.JuliaSyntax.SyntaxHead
│     Base.Sys.cpu_summary :: Union{Tuple{}, Tuple{IO}, Tuple{IO, AbstractVector{Base.Sys.CPUinfo}}}
│     Base.ScopedValues.LazyScopedValue
│     Base.JuliaSyntax.Tokenize.tokenize :: Tuple{Any}
│     Base.JuliaSyntax.children :: Tuple{Base.JuliaSyntax.TreeNode}
│     Dates.Wed
│     Base.findfirst :: Tuple{AbstractChar, AbstractString}
│     Base.findfirst :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}}
│     Dates.Aug
│     Dates.weeksinyear :: Tuple{Year}
│     LinearAlgebra.fillband! :: Union{Tuple{T}, Tuple{AbstractMatrix{T}, Any, Any, Any}} where T
│     Dates.Jun
│     LinearAlgebra.copytrito! :: Tuple{AbstractMatrix, AbstractMatrix, AbstractChar}
│     Base.Sort.DEFAULT_UNSTABLE
│     Base.MathConstants.γ
│     Base.BinaryPlatforms.libc :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.:∌
│     Base.JuliaSyntax.sourcetext :: Tuple{Any}
│     Base.JuliaSyntax.sourcetext :: Tuple{Base.JuliaSyntax.SourceFile}
│     Dates.Second :: Tuple{Any}
│     Dates.Second :: Tuple{Time}
│     LinearAlgebra.inertia :: Union{Tuple{BunchKaufman{TS}}, Tuple{TS}, Tuple{TR}} where {TR<:Union{AbstractFloat, Rational}, TS<:Union{Complex{TR}, TR}}
│     LinearAlgebra.zeroslike :: Tuple{Type, Tuple{AbstractUnitRange, Vararg{AbstractUnitRange}}}
│     SparseArrays.SparseArrays
│     Base.Libc.Libdl.RTLD_LOCAL
│     Dates.format :: Tuple{IO, Dates.AbstractDateToken, TimeType, Any}
│     FileWatching.FileWatching
│     Base.Filesystem.S_IXGRP
│     Base.showarg :: Tuple{IO, Any, Any}
│     Artifacts.Artifacts
│     Dates.Sep
│     Base.Filesystem.JL_O_TEMPORARY
│     Base.Filesystem.S_IRWXG
│     Dates.July
│     Base.JuliaSyntax.numeric_flags :: Tuple{Any}
│     Base.Filesystem.S_IWGRP
│     Base.BinaryPlatforms.parse_dl_name_version :: Union{Tuple{String}, Tuple{String, String}}
│     Dates.September
│     Base.JuliaSyntax.Kind
│     Base.Filesystem.JL_O_SEQUENTIAL
│     Base.:* :: Tuple{Union{Regex, AbstractChar, AbstractString}, Vararg{Union{Regex, AbstractChar, AbstractString}}}
│     Base.BinaryPlatforms.wordsize :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.Filesystem.JL_O_TRUNC
│     LinearAlgebra.diagview :: Union{Tuple{AbstractMatrix}, Tuple{AbstractMatrix, Integer}}
│     SHA.shake256 :: Tuple{Union{NTuple{N, UInt8} where N, AbstractVector{UInt8}}, UInt64}
│     Base.BinaryPlatforms.detect_libgfortran_version :: Tuple{}
│     Base.JuliaSyntax.tokenize :: Tuple{Any}
│     Base.JuliaSyntax.is_postfix_op_call :: Tuple{Any}
│     Base.JuliaSyntax.GreenTreeCursor
│     Base.Filesystem.JL_O_DIRECT
│     Base.Generator
│     LinearAlgebra.isbanded :: Tuple{AbstractMatrix, Integer, Integer}
│     Base.findprev :: Tuple{Any, Any}
│     Base.findprev :: Tuple{Function, Any, Any}
│     Base.findprev :: Tuple{AbstractChar, AbstractString, Integer}
│     Base.findprev :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}, Integer}
│     Base.JuliaSyntax.ParseStream
│     Base.JuliaSyntax.head :: Tuple{Base.JuliaSyntax.TreeNode{<:Base.JuliaSyntax.AbstractSyntaxData}}
│     Base.:⊆
│     Test.Test
│     Base.@main :: Tuple
│     Dates.Sat
│     Base.Filesystem.JL_O_NOFOLLOW
│     SparseArrays.fkeep! :: Union{Tuple{F}, Tuple{F, SparseArrays.AbstractSparseMatrixCSC}} where F<:Function
│     Base.AbstractMatch
│     Base.Filesystem.JL_O_FSYNC
│     Dates.Hour :: Tuple{Any}
│     Dates.Hour :: Tuple{Time}
│     Base.:^ :: Tuple{Regex, Integer}
│     Base.Sort.SMALL_ALGORITHM
│     Profile.flatten :: Tuple{Vector, Dict{UInt64, Vector{Base.StackTraces.StackFrame}}}
│     Dates.June
│     LinearAlgebra.LinearAlgebra
│     Dates.Fri
│     Base.Sys.PAGESIZE
│     Dates.Jul
│     Base.:⊋ :: Tuple{Any}
│     Base.:⊋
│     Base.JuliaSyntax.COLON_QUOTE
│     Base.JuliaSyntax.filename :: Tuple{Any}
│     InteractiveUtils.InteractiveUtils
│     Dates.Sunday
│     Dates.October
│     Base.BinaryPlatforms.detect_cxxstring_abi :: Tuple{}
│     LibGit2.LibGit2
│     Base.Filesystem.JL_O_SYNC
│     Base.JuliaSyntax.TRIPLE_STRING_FLAG
│     Base.CoreLogging.@info
│     Base.Meta.replace_sourceloc! :: Tuple{Any, Any}
│     Base.operator_precedence :: Tuple{Symbol}
│     Base.Filesystem.S_IWUSR
│     Base.JuliaSyntax.SourceFile
│     Base.findall :: Tuple{AbstractChar, AbstractString}
│     Base.findall :: Tuple{Union{AbstractPattern, AbstractString, AbstractVector{UInt8}}, Union{AbstractPattern, AbstractString, AbstractVector{UInt8}}}
│     Base.ncodeunits :: Tuple{Char}
│     Base.BinaryPlatforms.platform_name :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.Libc.Libdl.RTLD_DEEPBIND
│     Base.Libc.Libdl.RTLD_NOLOAD
│     Base.Filesystem.mktemp :: Tuple{Any}
│     Base.Filesystem.mktemp :: Union{Tuple{Function}, Tuple{Function, AbstractString}}
│     Serialization.Serialization
│     Tar.Tar
│     Base.Filesystem.JL_O_NDELAY
│     LinearAlgebra.hermitian :: Union{Tuple{AbstractMatrix}, Tuple{AbstractMatrix, Symbol}}
│     Base.JuliaSyntax.SyntaxNode
│     LinearAlgebra.fillstored! :: Tuple{Diagonal, Any}
│     Base.Experimental
│     Base.BinaryPlatforms.call_abi :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.AbstractSlices
│     Base.Meta.parse :: Tuple{AbstractString, Integer}
│     Dates.Mar
│     Base.HashArrayMappedTries.HAMT
│     Core.VecElement
│     Base.JuliaSyntax.char_range :: Tuple{Any}
│     Base.Sys.cpu_info :: Tuple{}
│     Base.operator_associativity :: Tuple{Symbol}
│     Base.UUID
│     Base.Meta.ispostfixoperator :: Tuple{Union{AbstractString, Symbol}}
│     Base.JuliaSyntax.RAW_STRING_FLAG
│     Base.Filesystem.JL_O_NOCTTY
│     Base.mapreduce :: Union{Tuple{D}, Tuple{Any, Any, Union{Base.AbstractBroadcasted, AbstractArray}}} where D
│     Base.Filesystem.JL_O_SHORT_LIVED
│     Base.JuliaSyntax.Token
│     Dates.Nanosecond :: Tuple{Any}
│     Base.Docs.doc
│     Dates.Jan
│     Base.Filesystem.S_IXOTH
│     Dates.Week :: Tuple{DateTime}
│     Dates.Week :: Tuple{Any}
│     Dates.Week :: Tuple{Date}
│     Base.JuliaSyntax.is_prefix_call :: Tuple{Any}
│     Dates.Thursday
│     Base.AbstractPipe
│     Base.all :: Tuple{Any, Any}
│     Base.all :: Tuple{AbstractArray}
│     Base.all :: Tuple{Function, AbstractArray}
│     Base.JuliaSyntax.is_trivia :: Tuple{Any}
│     Dates.Microsecond :: Tuple{Any}
│     Base.Filesystem.JL_O_DIRECTORY
│     Base.JuliaSyntax.RedTreeCursor
│     Base.Filesystem.S_IRGRP
│     Dates.Month :: Tuple{DateTime}
│     Dates.Month :: Tuple{Any}
│     Dates.Month :: Tuple{Date}
│     Base.load_path :: Tuple{}
│     Core.String :: Tuple{AbstractVector{UInt8}}
│     Core.String
│     Base.JuliaSyntax.MUTABLE_FLAG
│     Dates.April
│     Base.:⊉ :: Tuple{Any}
│     Base.:⊉
│     Base.BinaryPlatforms.CPUID.cpu_isa
│     Base.JuliaSyntax.SHORT_FORM_FUNCTION_FLAG
│     Dates.Saturday
│     Base.JuliaSyntax.GreenNode
│     REPL.REPL
│     Base.BinaryPlatforms.os :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.@acquire :: Tuple{Any, Any}
│     DelimitedFiles.DelimitedFiles
│     Downloads.Downloads
│     Base.:≉ :: Tuple
│     Base.Sys.CPUinfo
│     TOML.TOML
│     Dates.Dates
│     Base.reseteof :: Tuple{IO}
│     REPL.TerminalMenus
│     Base.CoreLogging.@warn
│     Dates.TimePeriod
│     Base.JuliaSyntax.BARE_MODULE_FLAG
│     Dates.Monday
│     Base.JuliaSyntax.untokenize :: Tuple{Base.JuliaSyntax.Kind}
│     Base.CoreLogging.@error
│     Base.Filesystem.JL_O_PATH
│     Base.CoreLogging.@debug
│     Base.MathConstants.e
│     Base.Filesystem.JL_O_TMPFILE
│     Base.text_colors
│     LinearAlgebra.hermitian_type :: Union{Tuple{Type{T}}, Tuple{T}, Tuple{S}} where {S, T<:AbstractMatrix{S}}
│     Base.JuliaSyntax.is_suffixed :: Tuple{Any}
│     Dates.January
│     Dates.Minute :: Tuple{Any}
│     Dates.Minute :: Tuple{Time}
│     Base.MathConstants
│     Base.JuliaSyntax.TOPLEVEL_SEMICOLONS_FLAG
│     Base.Filesystem.JL_O_EXCL
│     Base.reverse :: Union{Tuple{AbstractVector, Integer}, Tuple{AbstractVector, Integer, Integer}}
│     Base.reverse :: Union{Tuple{AbstractArray}, Tuple{D}} where D
│     Dates.Year :: Tuple{DateTime}
│     Dates.Year :: Tuple{Any}
│     Dates.Year :: Tuple{Date}
│     SHA.shake128 :: Tuple{Union{NTuple{N, UInt8} where N, AbstractVector{UInt8}}, UInt64}
│     Printf.Printf
│     Downloads.default_downloader! :: Union{Tuple{}, Tuple{Union{Nothing, Downloader}}}
│     Dates.DatePeriod
│     Base.BinaryPlatforms.libgfortran_version :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.JuliaSyntax.first_byte :: Tuple{Any}
│     Base.complex :: Tuple{AbstractArray{<:Complex}}
│     Base.complex :: Union{Tuple{Type{T}}, Tuple{T}} where T<:Real
│     Base.MathConstants.φ
│     Base.JuliaSyntax.parseatom :: Union{Tuple{T}, Tuple{Type{T}, AbstractString}} where T
│     Base.Filesystem.JL_O_DSYNC
│     Base.findlast :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}}
│     Base.JuliaSyntax.is_leaf :: Tuple{Base.JuliaSyntax.TreeNode}
│     Base.JuliaSyntax.parse! :: Tuple{Base.JuliaSyntax.ParseStream}
│     Base.JuliaSyntax.parse! :: Union{Tuple{TreeType}, Tuple{Type{TreeType}, IO}} where TreeType
│     Base.Filesystem.JL_O_CREAT
│     Profile.Profile
│     Base.findnext :: Tuple{Any, Any}
│     Base.findnext :: Tuple{Function, Any, Any}
│     Base.findnext :: Tuple{AbstractVector{<:Union{Int8, UInt8}}, AbstractVector{<:Union{Int8, UInt8}}, Integer}
│     Base.JuliaSyntax.@K_str :: Tuple{Any}
│     Dates.August
│     Base.BinaryPlatforms.libstdcxx_version :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     UUIDs.uuid7 :: Union{Tuple{}, Tuple{AbstractRNG}}
│     Base.axes :: Union{Tuple{N}, Tuple{T}, Tuple{AbstractArray{T, N}, Any}} where {T, N}
│     Dates.Thu
│     Base.JuliaSyntax.source_location :: Tuple{Any}
│     Base.__has_internal_change :: Tuple{VersionNumber, Symbol}
│     Dates.Feb
│     Base.BinaryPlatforms.arch :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Dates.Nov
│     Base.AbstractPattern
│     Base.JuliaSyntax.PARENS_FLAG
│     Base.Filesystem.S_IXUSR
│     Base.BinaryPlatforms.platform_dlext :: Union{Tuple{}, Tuple{Base.BinaryPlatforms.AbstractPlatform}}
│     Dates.Millisecond :: Tuple{Any}
│     Dates.Millisecond :: Tuple{Time}
│     Base.Filesystem.JL_O_ASYNC
│     Base.setgid
│     Base.Filesystem.JL_O_NOATIME
│     Dates.isoweekdate :: Tuple{DateTime}
│     Dates.Tue
│     LinearAlgebra.symmetric_type :: Union{Tuple{Type{T}}, Tuple{T}, Tuple{S}} where {S, T<:AbstractMatrix{S}}
│     Base.JuliaSyntax.parsestmt :: Union{Tuple{T}, Tuple{Type{T}, AbstractString}} where T
│     Dates.Day :: Tuple{DateTime}
│     Dates.Day :: Tuple{Any}
│     Dates.Day :: Tuple{Date}
│     Base.Filesystem.JL_O_RDWR
│     Base.BinaryPlatforms.detect_libstdcxx_version :: Union{Tuple{}, Tuple{Int64}}
│     Base.ScopedValues.ScopedThunk
│     Base.mul_hi :: Union{Tuple{T}, Tuple{T, T}} where T<:Integer
│     Sockets.join_multicast_group :: Union{Tuple{UDPSocket, String}, Tuple{UDPSocket, String, Union{Nothing, String}}}
│     Base.BinaryPlatforms.select_platform :: Union{Tuple{Dict}, Tuple{Dict, Base.BinaryPlatforms.AbstractPlatform}}
│     Base.JuliaSyntax.kind :: Tuple{Base.JuliaSyntax.Kind}
│     Base.Sys.detectwsl :: Tuple{}
│     Base.Libc.Libdl.RTLD_LAZY
│     Base.Filesystem.JL_O_RSYNC
│     Base.bitreverse :: Tuple{Union{Int128, Int16, Int32, Int64, Int8, UInt128, UInt16, UInt32, UInt64, UInt8}}
│     Base.Filesystem.mktempdir :: Union{Tuple{Function}, Tuple{Function, AbstractString}}
│     Base.Filesystem.mktempdir :: Union{Tuple{}, Tuple{AbstractString}}
│     Base.AbstractOneTo
│     Compiler.Timings
│     CRC32c.CRC32c
│     Base.JuliaSyntax.span :: Tuple{Base.JuliaSyntax.GreenNode}
│     Base.JuliaSyntax.span :: Tuple{Base.JuliaSyntax.GreenTreeCursor}
│     Base.BinaryPlatforms.os_version :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     InteractiveUtils.peakflops :: Union{Tuple{}, Tuple{Integer}}
│     Base.BinaryPlatforms.triplet :: Tuple{Base.BinaryPlatforms.AbstractPlatform}
│     Base.:⊇ :: Tuple{Any}
│     Base.:⊇
│     Base.Filesystem.StatStruct
│     Profile.@profile_walltime :: Tuple{Any}
│     Base.to_index :: Tuple{Any, Any}
│     Base.to_index :: Tuple{Integer}
│     Dates.Mon
│     Base.TOML
│     Base.JuliaSyntax.parseall :: Union{Tuple{T}, Tuple{Type{T}, AbstractString}} where T
│     Profile.add_fake_meta :: Tuple{Any}
│     Base.Libc.Libdl
│     Base.Sort.DEFAULT_STABLE
│     Dates.Friday
│ 
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in canonical @docs or @autodocs blocks.
└ @ Documenter /cache/build/builder-amdci4-1/julialang/julia-master/deps/jlutilities/depot/packages/Documenter/RfMTA/src/utilities/utilities.jl:49

@IanButterworth IanButterworth added the docs This change adds or pertains to documentation label Oct 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs This change adds or pertains to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant