Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing docstrings in manual #44642

Merged
merged 9 commits into from
May 9, 2022

Conversation

Saransh-cpp
Copy link
Contributor

Addresses #19529

Some comments -

  • Pkg, SparseArrays, and Statistics moved out.
  • CoreLogging is not exported for the users.
  • InteractiveUtils.peakflops was moved to LinearAlgebra, should I deprecate the function in another PR? (Comment above the function - # TODO: @deprecate peakflops to LinearAlgebra)
  • Base.Docs.Text and Basi.Docs.HTML are considered to be deprecated and should not be used.
  • I am not sure about how to add Base.Broadcast.broadcast_preserving_zero_d, Libdl exports, and some of the mathematical symbol exports from Base.
  • There are a lot of Dates exports (day and month names) whose API documentation is missing, should I add them?
  • Distributed.@spawn should not be used.
  • Base.Grisu and `Base.Threads.RecursiveSpinLock`` have been removed.

I've tried to update the list below, but I might have missed some docstrings.

  • Dates.Friday
  • Pkg.GraphType.simplify_graph! :: Union{Tuple{Pkg.GraphType.Graph}, Tuple{Pkg.GraphType.Graph,Set{Int64}}}
  • Base.:⊋
  • Test.detect_ambiguities :: Tuple
  • LibGit2.LibGit2
  • CRC32c.CRC32c
  • Base.:=>
  • Dates.Wed
  • Base.CoreLogging.current_logger :: Tuple{}
  • Dates.March
  • FileWatching.FileWatching
  • Base.real :: Tuple{Type}
  • Markdown.Markdown
  • Base.Sys.uptime :: Tuple{}
  • Base.Inf64
  • Pkg.Types.handle_repos_add! :: Tuple{Pkg.Types.Context,AbstractArray{Pkg.Types.PackageSpec,1}}
  • Base.CoreLogging.@warn
  • Dates.Sun
  • Dates.Oct
  • Base.CoreLogging.NullLogger
  • Dates.Week :: Tuple{Date}
  • Dates.Week :: Tuple{DateTime}
  • Dates.Week :: Tuple{Any}
  • Base.MathConstants
  • Pkg.GraphType.add_fixed! :: Tuple{Pkg.GraphType.Graph,Dict{UUID,Pkg.Types.Fixed}}
  • Libdl.Libdl
  • Base.complex :: Union{Tuple{Type{T}}, Tuple{T}} where T<:Real
  • Future.Future
  • Libdl.RTLD_GLOBAL
  • Dates.Nanosecond :: Tuple{Any}
  • Base.empty :: Union{Tuple{AbstractArray{T,1}}, Tuple{U}, Tuple{T}, Tuple{AbstractArray{T,1},Type{U}}} where U where T
  • Base.empty :: Tuple{AbstractDict}
  • Base.empty :: Tuple{Any}
  • Dates.Year :: Tuple{Date}
  • Dates.Year :: Tuple{DateTime}
  • Dates.Year :: Tuple{Any}
  • Base.MathConstants.π
  • Base.CoreLogging.LogLevel
  • Dates.May
  • Pkg.RegistrySpec
  • Base.CoreLogging.AbstractLogger
  • Dates.Day :: Tuple{Date}
  • Dates.Day :: Tuple{DateTime}
  • Dates.Day :: Tuple{Any}
  • Base.Sys.which :: Tuple{String}
  • Dates.Microsecond :: Tuple{Any}
  • Base.which :: Tuple{Module,Symbol}
  • Pkg.Resolve.sanity_check :: Union{Tuple{Pkg.GraphType.Graph}, Tuple{Pkg.GraphType.Graph,Set{UUID}}, Tuple{Pkg.GraphType.Graph,Set{UUID},Bool}}
  • Dates.Apr
  • Pkg.GraphType.get_resolve_log :: Tuple{Pkg.GraphType.Graph}
  • Pkg.GraphType.showlog :: Tuple{IO,Pkg.GraphType.ResolveLog}
  • Pkg.GraphType.showlog :: Tuple{IO,Pkg.GraphType.ResolveLog,UUID}
  • Base.Grisu.grisu :: Union{Tuple{AbstractFloat,Any,Any}, Tuple{AbstractFloat,Any,Any,Any}, Tuple{AbstractFloat,Any,Any,Any,Any}} - REMOVED
  • Base.:* :: Tuple{Union{Regex, AbstractChar, AbstractString},Vararg{Union{Regex, AbstractChar, AbstractString},N} where N}
  • Test.GenericSet
  • Base.findprev :: Tuple{AbstractChar,AbstractString,Integer}
  • Base.findprev :: Tuple{Function,Any,Any}
  • Base.findprev :: Tuple{Any,Any}
  • Base.eachcol :: Tuple{Union{AbstractArray{T,1}, AbstractArray{T,2}} where T}
  • Dates.Sat
  • Libdl.RTLD_NOLOAD
  • Base.Threads.RecursiveSpinLock
  • Base.MathConstants.φ
  • REPL.TerminalMenus.RadioMenu
  • REPL.TerminalMenus.RadioMenu :: Tuple{Array{String,1}}
  • Dates.November
  • Dates.Thursday
  • Dates.Thu
  • Libdl.RTLD_DEEPBIND
  • Base.Broadcast.broadcast_preserving_zero_d :: Tuple{Any,Vararg{Any,N} where N}
  • Base.MathConstants.γ
  • Base.float :: Union{Tuple{Type{T}}, Tuple{T}} where T<:Number
  • Dates.Sep
  • Dates.June
  • LibGit2.GitConfig :: Union{Tuple{AbstractString}, Tuple{AbstractString,LibGit2.Consts.GIT_CONFIG}, Tuple{AbstractString,LibGit2.Consts.GIT_CONFIG,Union{Nothing, GitRepo}}, Tuple{AbstractString,LibGit2.Consts.GIT_CONFIG,Union{Nothing, GitRepo},Bool}}
  • LibGit2.GitConfig :: Tuple{GitRepo}
  • LibGit2.GitConfig :: Union{Tuple{}, Tuple{LibGit2.Consts.GIT_CONFIG}}
  • Dates.Millisecond :: Tuple{Time}
  • Dates.Millisecond :: Tuple{Any}
  • Base.Filesystem.contractuser :: Tuple{AbstractString} - Not available to users?
  • Base.Regex
  • Base.Sys.isjsvm :: Tuple{Symbol}
  • Base.CoreLogging.@error
  • Statistics.Statistics - Moved out
  • Libdl.RTLD_NODELETE
  • Base.eachslice :: Tuple{AbstractArray}
  • Dates.July
  • Dates.April
  • Base.eachrow :: Tuple{Union{AbstractArray{T,1}, AbstractArray{T,2}} where T}
  • Distributed.ProcessExitedException
  • Dates.canonicalize :: Tuple{Dates.CompoundPeriod}
  • Base.reduce :: Tuple{Any,AbstractArray}
  • REPL.TerminalMenus.request :: Tuple{REPL.TerminalMenus.AbstractMenu}
  • REPL.TerminalMenus.request :: Tuple{AbstractString,REPL.TerminalMenus.AbstractMenu}
  • Dates.January
  • Dates.Fri
  • Pkg.PackageSpec
  • Base.Rounding.setrounding :: Union{Tuple{T}, Tuple{Function,Type{T},RoundingMode}} where T
  • Pkg.UpgradeLevel
  • Test.GenericString
  • Base.:∌
  • Base.CoreLogging.SimpleLogger
  • DelimitedFiles.DelimitedFiles
  • Dates.Month :: Tuple{Date}
  • Dates.Month :: Tuple{DateTime}
  • Dates.Month :: Tuple{Any}
  • Libdl.RTLD_LOCAL
  • Dates.September
  • Dates.Hour :: Tuple{Time}
  • Dates.Hour :: Tuple{Any}
  • Base.CoreLogging.global_logger :: Tuple{}
  • REPL.TerminalMenus.MultiSelectMenu
  • REPL.TerminalMenus.MultiSelectMenu :: Tuple{Array{String,1}}
  • Base.mapreduce :: Tuple{Any,Any,AbstractArray}
  • Core.NTuple
  • Profile.Profile
  • Base.AbstractChannel
  • Base.Math.sincosd :: Tuple{Real}
  • Test.GenericOrder
  • Test.GenericDict
  • Dates.Jul
  • Dates.August
  • Test.TestSetException
  • Base.CoreLogging.@debug
  • Base.:⊇
  • Base.CoreLogging.with_logger :: Tuple{Function,Base.CoreLogging.AbstractLogger}
  • Base.Sys.loadavg :: Tuple{}
  • Dates.Aug
  • Libdl.RTLD_LAZY
  • Base.Pipe :: Tuple{}
  • Pkg.Resolve.resolve :: Tuple{Pkg.GraphType.Graph}
  • Dates.Tue
  • Dates.Saturday
  • Dates.Monday
  • Base.Filesystem.mktempdir :: Union{Tuple{Function}, Tuple{Function,Any}}
  • Base.Filesystem.mktempdir :: Union{Tuple{}, Tuple{Any}}
  • Serialization.Serialization
  • Test.Test
  • Base.NaN64
  • Mmap.Mmap
  • Base.Sys.isexecutable :: Tuple{String}
  • Base.:^ :: Tuple{Regex,Integer}
  • Base.:^ :: Tuple{Union{AbstractChar, AbstractString},Integer}
  • Dates.Nov
  • Dates.Minute :: Tuple{Time}
  • Dates.Minute :: Tuple{Any}
  • Base.Sys.STDLIB
  • Base.CoreLogging.disable_logging :: Tuple{Base.CoreLogging.LogLevel}
  • LinearAlgebra.LinearAlgebra
  • Base.Docs.HTML
  • Base.:≉ :: Tuple
  • Base.sizeof :: Tuple{Any}
  • Distributed.@Spawn :: Tuple{Any} - DEPRECATED
  • Dates.Dec
  • Base.findfirst :: Tuple{AbstractChar,AbstractString}
  • Dates.February
  • Base.Experimental
  • Test.detect_unbound_args :: Tuple
  • Dates.October
  • Base.CoreLogging.@logmsg
  • Base.copy! :: Tuple{AbstractArray{T,1} where T,AbstractArray{T,1} where T}
  • Dates.Mon
  • Base.TaskFailedException
  • Dates.Tuesday
  • Base.Docs.Text
  • Base.MathConstants.e
  • Base.:∋
  • Base.reverse :: Tuple{AbstractArray}
  • Base.reverse :: Union{Tuple{AbstractArray{T,1} where T}, Tuple{AbstractArray{T,1} where T,Any}, Tuple{AbstractArray{T,1} where T,Any,Any}}
  • Base.:⊆
  • Base.findnext :: Tuple{Function,Any,Any}
  • Base.findnext :: Tuple{Any,Any}
  • Distributed.Distributed
  • Core.@cmd :: Tuple{Any}
  • Dates.Second :: Tuple{Time}
  • Dates.Second :: Tuple{Any}
  • Dates.Mar
  • SharedArrays.SharedArrays
  • SparseArrays.SparseArrays
  • InteractiveUtils.peakflops :: Union{Tuple{}, Tuple{Integer}}
  • Pkg.PackageMode
  • Base.findall :: Tuple{Union{Regex, AbstractString},AbstractString}
  • Base.CoreLogging.@info
  • Dates.Dates
  • Base.:⊉
  • Dates.Jun
  • Libdl.RTLD_FIRST
  • Test.GenericArray
  • Pkg.GraphType.add_reqs! :: Tuple{Pkg.GraphType.Graph,Dict{UUID,Pkg.Types.VersionSpec}}
  • Dates.Feb
  • Dates.Jan
  • Dates.Sunday
  • Dates.December
  • Base.ncodeunits :: Tuple{Char}
  • Dates.Wednesday

@Saransh-cpp Saransh-cpp force-pushed the add-missing-docstrings branch from cd59d9a to af65f2c Compare March 16, 2022 16:39
@ViralBShah ViralBShah added the docs This change adds or pertains to documentation label Mar 16, 2022
@KristofferC
Copy link
Member

LGTM

@KristofferC KristofferC added the merge me PR is reviewed. Merge when all tests are passing label May 6, 2022
@vtjnash vtjnash merged commit 3023693 into JuliaLang:master May 9, 2022
@Saransh-cpp Saransh-cpp deleted the add-missing-docstrings branch May 9, 2022 16:16
@giordano giordano removed the merge me PR is reviewed. Merge when all tests are passing label May 13, 2022
Keno pushed a commit that referenced this pull request Jun 5, 2024
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.

5 participants