Skip to content

Commit

Permalink
Add some missing docstrings in manual (#44642)
Browse files Browse the repository at this point in the history
  • Loading branch information
Saransh-cpp authored May 9, 2022
1 parent 177bf28 commit 3023693
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/src/base/base.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@ Base.@elapsed
Base.@allocated
Base.EnvDict
Base.ENV
Base.Sys.STDLIB
Base.Sys.isunix
Base.Sys.isapple
Base.Sys.islinux
Expand All @@ -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
```

Expand Down Expand Up @@ -385,6 +390,7 @@ Core.OutOfMemoryError
Core.ReadOnlyMemoryError
Core.OverflowError
Base.ProcessFailedException
Base.TaskFailedException
Core.StackOverflowError
Base.SystemError
Core.TypeError
Expand Down
2 changes: 2 additions & 0 deletions doc/src/base/numbers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions doc/src/base/parallel.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Base.ReentrantLock
## Channels

```@docs
Base.AbstractChannel
Base.Channel
Base.Channel(::Function)
Base.put!(::Channel, ::Any)
Expand Down
2 changes: 2 additions & 0 deletions stdlib/CRC32c/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# CRC32c

Standard library module for computing the CRC-32c checksum.

```@docs
CRC32c.crc32c
CRC32c.crc32c(::IO, ::Integer, ::UInt32)
Expand Down
2 changes: 2 additions & 0 deletions stdlib/DelimitedFiles/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 2 additions & 0 deletions stdlib/Distributed/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# [Distributed Computing](@id man-distributed)
Tools for distributed parallel processing.

```@docs
Distributed.addprocs
Expand All @@ -12,6 +13,7 @@ Distributed.interrupt
Distributed.myid
Distributed.pmap
Distributed.RemoteException
Distributed.ProcessExitedException
Distributed.Future
Distributed.RemoteChannel
Distributed.fetch(::Distributed.Future)
Expand Down
3 changes: 3 additions & 0 deletions stdlib/LibGit2/docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ LibGit2.GitAnnotated
LibGit2.GitBlame
LibGit2.GitBlob
LibGit2.GitCommit
LibGit2.GitConfig
LibGit2.GitHash
LibGit2.GitObject
LibGit2.GitRemote
Expand All @@ -52,6 +53,7 @@ LibGit2.StatusEntry
LibGit2.StatusOptions
LibGit2.StrArrayStruct
LibGit2.TimeStruct
LibGit2.addfile
LibGit2.add!
LibGit2.add_fetch!
LibGit2.add_push!
Expand Down Expand Up @@ -158,4 +160,5 @@ LibGit2.CachedCredentials
LibGit2.CredentialPayload
LibGit2.approve
LibGit2.reject
LibGit2.Consts.GIT_CONFIG
```
2 changes: 2 additions & 0 deletions stdlib/Mmap/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Memory-mapped I/O

Low level module for mmap (memory mapping of files).

```@docs
Mmap.Anonymous
Mmap.mmap
Expand Down
7 changes: 7 additions & 0 deletions stdlib/REPL/docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -728,6 +728,13 @@ Base.atreplinit

### TerminalMenus

### Menus

```@docs
REPL.TerminalMenus.RadioMenu
REPL.TerminalMenus.MultiSelectMenu
```

#### Configuration

```@docs
Expand Down
2 changes: 2 additions & 0 deletions stdlib/Serialization/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Serialization

Provides serialization of Julia objects.

```@docs
Serialization.serialize
Serialization.deserialize
Expand Down
2 changes: 2 additions & 0 deletions stdlib/SharedArrays/docs/src/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 3023693

Please sign in to comment.