From 3023693b33565b8e3fc10ddf404dd2f74f23fb54 Mon Sep 17 00:00:00 2001 From: Saransh Date: Mon, 9 May 2022 21:14:21 +0530 Subject: [PATCH] Add some missing docstrings in manual (#44642) --- doc/src/base/base.md | 6 ++++++ doc/src/base/numbers.md | 2 ++ doc/src/base/parallel.md | 1 + stdlib/CRC32c/docs/src/index.md | 2 ++ stdlib/DelimitedFiles/docs/src/index.md | 2 ++ stdlib/Distributed/docs/src/index.md | 2 ++ stdlib/LibGit2/docs/src/index.md | 3 +++ stdlib/Mmap/docs/src/index.md | 2 ++ stdlib/REPL/docs/src/index.md | 7 +++++++ stdlib/Serialization/docs/src/index.md | 2 ++ stdlib/SharedArrays/docs/src/index.md | 2 ++ 11 files changed, 31 insertions(+) diff --git a/doc/src/base/base.md b/doc/src/base/base.md index 93d0547098706..6b80072fbd630 100644 --- a/doc/src/base/base.md +++ b/doc/src/base/base.md @@ -332,6 +332,7 @@ Base.@elapsed Base.@allocated Base.EnvDict Base.ENV +Base.Sys.STDLIB Base.Sys.isunix Base.Sys.isapple Base.Sys.islinux @@ -344,6 +345,10 @@ Base.Sys.iswindows Base.Sys.windows_version Base.Sys.free_memory Base.Sys.total_memory +Base.Sys.uptime +Base.Sys.isjsvm +Base.Sys.loadavg +Base.Sys.isexecutable Base.@static ``` @@ -385,6 +390,7 @@ Core.OutOfMemoryError Core.ReadOnlyMemoryError Core.OverflowError Base.ProcessFailedException +Base.TaskFailedException Core.StackOverflowError Base.SystemError Core.TypeError diff --git a/doc/src/base/numbers.md b/doc/src/base/numbers.md index b92bf6a1d8768..3c2cf2626a11e 100644 --- a/doc/src/base/numbers.md +++ b/doc/src/base/numbers.md @@ -72,9 +72,11 @@ Base.MathConstants.catalan Base.MathConstants.eulergamma Base.MathConstants.golden Base.Inf +Base.Inf64 Base.Inf32 Base.Inf16 Base.NaN +Base.NaN64 Base.NaN32 Base.NaN16 Base.issubnormal diff --git a/doc/src/base/parallel.md b/doc/src/base/parallel.md index 47f18d77f654c..377463f353bd3 100644 --- a/doc/src/base/parallel.md +++ b/doc/src/base/parallel.md @@ -56,6 +56,7 @@ Base.ReentrantLock ## Channels ```@docs +Base.AbstractChannel Base.Channel Base.Channel(::Function) Base.put!(::Channel, ::Any) diff --git a/stdlib/CRC32c/docs/src/index.md b/stdlib/CRC32c/docs/src/index.md index 13047099a7f9d..24a073d1e3938 100644 --- a/stdlib/CRC32c/docs/src/index.md +++ b/stdlib/CRC32c/docs/src/index.md @@ -1,5 +1,7 @@ # CRC32c +Standard library module for computing the CRC-32c checksum. + ```@docs CRC32c.crc32c CRC32c.crc32c(::IO, ::Integer, ::UInt32) diff --git a/stdlib/DelimitedFiles/docs/src/index.md b/stdlib/DelimitedFiles/docs/src/index.md index 11e24f12ff3c1..a0ce8d61e342e 100644 --- a/stdlib/DelimitedFiles/docs/src/index.md +++ b/stdlib/DelimitedFiles/docs/src/index.md @@ -1,5 +1,7 @@ # Delimited Files +Utilities for reading and writing delimited files, for example ".csv". + ```@docs DelimitedFiles.readdlm(::Any, ::AbstractChar, ::Type, ::AbstractChar) DelimitedFiles.readdlm(::Any, ::AbstractChar, ::AbstractChar) diff --git a/stdlib/Distributed/docs/src/index.md b/stdlib/Distributed/docs/src/index.md index dc8cef5e22d92..00b40de49b396 100644 --- a/stdlib/Distributed/docs/src/index.md +++ b/stdlib/Distributed/docs/src/index.md @@ -1,4 +1,5 @@ # [Distributed Computing](@id man-distributed) +Tools for distributed parallel processing. ```@docs Distributed.addprocs @@ -12,6 +13,7 @@ Distributed.interrupt Distributed.myid Distributed.pmap Distributed.RemoteException +Distributed.ProcessExitedException Distributed.Future Distributed.RemoteChannel Distributed.fetch(::Distributed.Future) diff --git a/stdlib/LibGit2/docs/src/index.md b/stdlib/LibGit2/docs/src/index.md index e53a9330cb1d2..4024bc6f28f0f 100644 --- a/stdlib/LibGit2/docs/src/index.md +++ b/stdlib/LibGit2/docs/src/index.md @@ -26,6 +26,7 @@ LibGit2.GitAnnotated LibGit2.GitBlame LibGit2.GitBlob LibGit2.GitCommit +LibGit2.GitConfig LibGit2.GitHash LibGit2.GitObject LibGit2.GitRemote @@ -52,6 +53,7 @@ LibGit2.StatusEntry LibGit2.StatusOptions LibGit2.StrArrayStruct LibGit2.TimeStruct +LibGit2.addfile LibGit2.add! LibGit2.add_fetch! LibGit2.add_push! @@ -158,4 +160,5 @@ LibGit2.CachedCredentials LibGit2.CredentialPayload LibGit2.approve LibGit2.reject +LibGit2.Consts.GIT_CONFIG ``` diff --git a/stdlib/Mmap/docs/src/index.md b/stdlib/Mmap/docs/src/index.md index ada88b153de64..5c40f11db4a4c 100644 --- a/stdlib/Mmap/docs/src/index.md +++ b/stdlib/Mmap/docs/src/index.md @@ -1,5 +1,7 @@ # Memory-mapped I/O +Low level module for mmap (memory mapping of files). + ```@docs Mmap.Anonymous Mmap.mmap diff --git a/stdlib/REPL/docs/src/index.md b/stdlib/REPL/docs/src/index.md index af69ed0f67c73..4120f0ae4c6c3 100644 --- a/stdlib/REPL/docs/src/index.md +++ b/stdlib/REPL/docs/src/index.md @@ -728,6 +728,13 @@ Base.atreplinit ### TerminalMenus +### Menus + +```@docs +REPL.TerminalMenus.RadioMenu +REPL.TerminalMenus.MultiSelectMenu +``` + #### Configuration ```@docs diff --git a/stdlib/Serialization/docs/src/index.md b/stdlib/Serialization/docs/src/index.md index c01ead7a7eaea..9f593a2e807d9 100644 --- a/stdlib/Serialization/docs/src/index.md +++ b/stdlib/Serialization/docs/src/index.md @@ -1,5 +1,7 @@ # Serialization +Provides serialization of Julia objects. + ```@docs Serialization.serialize Serialization.deserialize diff --git a/stdlib/SharedArrays/docs/src/index.md b/stdlib/SharedArrays/docs/src/index.md index 7b23ec15fdaa2..67ceabf42115a 100644 --- a/stdlib/SharedArrays/docs/src/index.md +++ b/stdlib/SharedArrays/docs/src/index.md @@ -1,5 +1,7 @@ # Shared Arrays +`SharedArray` represents an array, which is shared across multiple processes, on a single machine. + ```@docs SharedArrays.SharedArray SharedArrays.SharedVector