Skip to content

Commit e860b3a

Browse files
add already existing public docstrings to the manual
1 parent cd2ebf9 commit e860b3a

File tree

29 files changed

+297
-3
lines changed

29 files changed

+297
-3
lines changed

doc/src/base/arrays.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ Base.isperm
209209
Base.permute!(::Any, ::AbstractVector)
210210
Base.invpermute!
211211
Base.reverse(::AbstractVector; kwargs...)
212+
Base.reverse(::Tuple)
212213
Base.reverseind
213214
Base.reverse!
214215
```

doc/src/base/base.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,13 @@ Main.include
3434
Base.include_string
3535
Base.include_dependency
3636
__init__
37+
Base.@main
3738
Base.OncePerProcess
3839
Base.OncePerTask
3940
Base.OncePerThread
4041
Base.which(::Any, ::Any)
42+
Base.which(::Any)
43+
Base.which(::Module, ::Symbol)
4144
Base.methods
4245
Base.@show
4346
ans
@@ -172,6 +175,11 @@ Core.setfieldonce!
172175
Core.isdefined
173176
Core.isdefinedglobal
174177
Base.@isdefined
178+
Base.@__FILE__
179+
Base.@__DIR__
180+
Base.@__LINE__
181+
Base.@__MODULE__
182+
Base.@__FUNCTION__
175183
Base.convert
176184
Base.promote
177185
Base.oftype
@@ -358,7 +366,9 @@ Base.Sys.get_process_title
358366
Base.ignorestatus
359367
Base.detach
360368
Base.Cmd
369+
Core.@cmd(::String)
361370
Base.setenv
371+
```
362372
Base.addenv
363373
Base.withenv
364374
Base.shell_escape
@@ -370,6 +380,7 @@ Base.escape_microsoft_c_args
370380
Base.setcpuaffinity
371381
Base.pipeline(::Any, ::Any, ::Any, ::Any...)
372382
Base.pipeline(::Base.AbstractCmd)
383+
Base.pipeline(::Base.AbstractCmd, ::Any)
373384
Base.Libc.gethostname
374385
Base.Libc.getpid
375386
Base.Libc.time()
@@ -409,6 +420,12 @@ Base.Sys.isreadable
409420
Base.Sys.iswritable
410421
Base.Sys.which
411422
Base.Sys.username
423+
Base.Sys.cpu_info
424+
Base.Sys.cpu_summary()
425+
Base.Sys.cpu_summary(::IO)
426+
Base.Sys.cpu_summary(::IO, ::AbstractVector{Base.Sys.CPUinfo})
427+
Base.Sys.CPUinfo
428+
Base.Sys.detectwsl
412429
Base.@static
413430
```
414431
@@ -421,6 +438,10 @@ Base.@v_str
421438

422439
## Errors
423440

441+
```@docs
442+
Base.Experimental
443+
```
444+
424445
```@docs
425446
Base.error
426447
Core.throw
@@ -442,6 +463,7 @@ Base.EOFError
442463
Core.ErrorException
443464
Core.FieldError
444465
Core.InexactError
466+
Core.InitError
445467
Core.InterruptException
446468
Base.KeyError
447469
Base.LoadError
@@ -561,4 +583,10 @@ Meta.isoperator
561583
Meta.isunaryoperator
562584
Meta.isbinaryoperator
563585
Meta.show_sexpr
586+
Meta.parse(::AbstractString, ::Integer)
587+
Meta.replace_sourceloc!
588+
Meta.ispostfixoperator
589+
Base.operator_precedence
590+
Base.operator_associativity
591+
Base.remove_linenums!
564592
```

doc/src/base/collections.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ Fully implemented by:
8787

8888
## Iterable Collections
8989

90+
```@docs
91+
Base.Generator
92+
```
93+
9094
```@docs
9195
Base.in
9296
Base.:∉
@@ -119,15 +123,23 @@ Base.prod
119123
Base.prod!
120124
Base.any(::Any)
121125
Base.any(::AbstractArray, ::Any)
126+
Base.any(::Any, ::Any)
127+
Base.any(::AbstractArray)
128+
Base.any(::Function, ::AbstractArray)
122129
Base.any!
123130
Base.all(::Any)
124131
Base.all(::AbstractArray, ::Any)
132+
Base.all(::Any, ::Any)
133+
Base.all(::AbstractArray)
134+
Base.all(::Function, ::AbstractArray)
125135
Base.all!
126136
Base.count
137+
Base.count!(::AbstractArray, ::Union{Base.AbstractBroadcasted, AbstractArray})
127138
Base.foreach
128139
Base.map
129140
Base.map!
130141
Base.mapreduce(::Any, ::Any, ::Any)
142+
Base.mapreduce(::Any, ::Any, ::Union{Base.AbstractBroadcasted, AbstractArray})
131143
Base.mapfoldl(::Any, ::Any, ::Any)
132144
Base.mapfoldr(::Any, ::Any, ::Any)
133145
Base.first

doc/src/base/constants.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ Base.Sys.WORD_SIZE
1515
Base.Sys.KERNEL
1616
Base.Sys.ARCH
1717
Base.Sys.MACHINE
18+
Base.Sys.CPU_NAME
19+
Base.Sys.PAGESIZE
20+
Base.Sys.JIT
21+
```
22+
23+
## [Mathematical Constants](@id math-constants)
24+
25+
```@docs
26+
Base.MathConstants
27+
Base.MathConstants.π
28+
Base.MathConstants.ℯ
29+
Base.MathConstants.γ
30+
Base.MathConstants.φ
1831
```
1932

2033
See also:

doc/src/base/file.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ Base.Filesystem.rm
3434
Base.Filesystem.touch
3535
Base.Filesystem.tempname
3636
Base.Filesystem.tempdir
37+
Base.Filesystem.mktemp(::Any)
3738
Base.Filesystem.mktemp(::AbstractString)
39+
Base.Filesystem.mktemp(::Function)
3840
Base.Filesystem.mktemp(::Function, ::AbstractString)
3941
Base.Filesystem.mktempdir(::AbstractString)
4042
Base.Filesystem.mktempdir(::Function, ::AbstractString)
@@ -67,4 +69,56 @@ Base.Filesystem.splitdir
6769
Base.Filesystem.splitdrive
6870
Base.Filesystem.splitext
6971
Base.Filesystem.splitpath
72+
Base.Filesystem.StatStruct
73+
Base.setuid
74+
Base.setgid
75+
```
76+
77+
## File Open Flags
78+
79+
```@docs
80+
Base.Filesystem.JL_O_APPEND
81+
Base.Filesystem.JL_O_ASYNC
82+
Base.Filesystem.JL_O_CLOEXEC
83+
Base.Filesystem.JL_O_CREAT
84+
Base.Filesystem.JL_O_DIRECT
85+
Base.Filesystem.JL_O_DIRECTORY
86+
Base.Filesystem.JL_O_DSYNC
87+
Base.Filesystem.JL_O_EXCL
88+
Base.Filesystem.JL_O_FSYNC
89+
Base.Filesystem.JL_O_LARGEFILE
90+
Base.Filesystem.JL_O_NDELAY
91+
Base.Filesystem.JL_O_NOATIME
92+
Base.Filesystem.JL_O_NOCTTY
93+
Base.Filesystem.JL_O_NOFOLLOW
94+
Base.Filesystem.JL_O_NONBLOCK
95+
Base.Filesystem.JL_O_PATH
96+
Base.Filesystem.JL_O_RANDOM
97+
Base.Filesystem.JL_O_RDONLY
98+
Base.Filesystem.JL_O_RDWR
99+
Base.Filesystem.JL_O_RSYNC
100+
Base.Filesystem.JL_O_SEQUENTIAL
101+
Base.Filesystem.JL_O_SHORT_LIVED
102+
Base.Filesystem.JL_O_SYNC
103+
Base.Filesystem.JL_O_TEMPORARY
104+
Base.Filesystem.JL_O_TMPFILE
105+
Base.Filesystem.JL_O_TRUNC
106+
Base.Filesystem.JL_O_WRONLY
107+
```
108+
109+
## File Permissions
110+
111+
```@docs
112+
Base.Filesystem.S_IRUSR
113+
Base.Filesystem.S_IWUSR
114+
Base.Filesystem.S_IXUSR
115+
Base.Filesystem.S_IRWXU
116+
Base.Filesystem.S_IRGRP
117+
Base.Filesystem.S_IWGRP
118+
Base.Filesystem.S_IXGRP
119+
Base.Filesystem.S_IRWXG
120+
Base.Filesystem.S_IROTH
121+
Base.Filesystem.S_IWOTH
122+
Base.Filesystem.S_IXOTH
123+
Base.Filesystem.S_IRWXO
70124
```

doc/src/base/io-network.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ Base.IOContext(::IO, ::IOContext)
6565

6666
```@docs
6767
Base.show(::IO, ::Any)
68+
Base.showarg
6869
Base.summary
6970
Base.print
7071
Base.println
@@ -141,6 +142,7 @@ Base.Multimedia.istextmime
141142

142143
```@docs
143144
Base.bytesavailable
145+
Base.reseteof
144146
Base.ntoh
145147
Base.hton
146148
Base.ltoh

doc/src/base/multi-threading.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,12 @@ Base.Threads.atomic_min!
5252
Base.Threads.atomic_fence
5353
```
5454

55+
## Semaphores
56+
57+
```@docs
58+
Base.@acquire
59+
```
60+
5561
## ccall using a libuv threadpool (Experimental)
5662

5763
```@docs

doc/src/base/numbers.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Base.big
8383
Base.signed
8484
Base.unsigned
8585
Base.float(::Any)
86+
Base.float(::AbstractArray)
8687
Base.Math.significand
8788
Base.Math.exponent
8889
Base.complex(::Complex)
@@ -100,7 +101,6 @@ Base.oneunit
100101
Base.zero
101102
Base.im
102103
Base.MathConstants.pi
103-
Base.MathConstants.ℯ
104104
Base.MathConstants.catalan
105105
Base.MathConstants.eulergamma
106106
Base.MathConstants.golden
@@ -140,6 +140,8 @@ Base.leading_zeros
140140
Base.leading_ones
141141
Base.trailing_zeros
142142
Base.trailing_ones
143+
Base.bitreverse
144+
Base.mul_hi
143145
Base.isodd
144146
Base.iseven
145147
Base.@int128_str

doc/src/base/punctuation.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,21 @@ Extended documentation for mathematical symbols & functions is [here](@ref math-
6060
| [`\|>`](@ref) | pipe operator passes output from the left argument to input of the right argument, usually a [function](@ref Function-composition-and-piping) |
6161
| `` | function composition operator (typed with \circ{tab}) combines two functions as though they are a single larger [function](@ref Function-composition-and-piping) |
6262
| `_` | underscores may be assigned values which will not be saved, often used to ignore [multiple return values](@ref destructuring-assignment) or create repetitive [comprehensions](@ref man-comprehensions) |
63+
64+
## Operators
65+
66+
```@docs
67+
Base.:*(::(Union{AbstractChar, AbstractString, Regex}), ::Vararg{Union{AbstractChar, AbstractString, Regex}})
68+
Base.:^(::Regex, ::Integer)
69+
Base.:∋(::Any, ::Any)
70+
Base.:∋(::Any)
71+
Base.:∌
72+
Base.:⊆
73+
Base.:⊇(::Any)
74+
Base.:⊇
75+
Base.:⊉(::Any)
76+
Base.:⊉
77+
Base.:⊋(::Any)
78+
Base.:⊋
79+
Base.:≉
80+
```

doc/src/base/scopedvalues.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,8 @@ end
313313

314314
```@docs
315315
Base.ScopedValues.ScopedValue
316+
Base.ScopedValues.LazyScopedValue
317+
Base.ScopedValues.ScopedThunk
316318
Base.ScopedValues.with
317319
Base.ScopedValues.@with
318320
Base.isassigned(::Base.ScopedValues.ScopedValue)

0 commit comments

Comments
 (0)