Skip to content

Commit 6995920

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

File tree

29 files changed

+300
-2
lines changed

29 files changed

+300
-2
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: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,16 @@ Main.include
3434
Base.include_string
3535
Base.include_dependency
3636
__init__
37+
Base.@main
3738
Base.OncePerProcess
39+
```
3840
Base.OncePerTask
3941
Base.OncePerThread
4042
Base.which(::Any, ::Any)
43+
Base.which(::Any)
44+
Base.which(::Module, ::Symbol)
4145
Base.methods
46+
```
4247
Base.@show
4348
ans
4449
err
@@ -358,7 +363,9 @@ Base.Sys.get_process_title
358363
Base.ignorestatus
359364
Base.detach
360365
Base.Cmd
366+
Core.@cmd(::String)
361367
Base.setenv
368+
```
362369
Base.addenv
363370
Base.withenv
364371
Base.shell_escape
@@ -370,6 +377,7 @@ Base.escape_microsoft_c_args
370377
Base.setcpuaffinity
371378
Base.pipeline(::Any, ::Any, ::Any, ::Any...)
372379
Base.pipeline(::Base.AbstractCmd)
380+
Base.pipeline(::Base.AbstractCmd, ::Any)
373381
Base.Libc.gethostname
374382
Base.Libc.getpid
375383
Base.Libc.time()
@@ -409,6 +417,12 @@ Base.Sys.isreadable
409417
Base.Sys.iswritable
410418
Base.Sys.which
411419
Base.Sys.username
420+
Base.Sys.cpu_info
421+
Base.Sys.cpu_summary()
422+
Base.Sys.cpu_summary(::IO)
423+
Base.Sys.cpu_summary(::IO, ::AbstractVector{Base.Sys.CPUinfo})
424+
Base.Sys.CPUinfo
425+
Base.Sys.detectwsl
412426
Base.@static
413427
```
414428
@@ -421,6 +435,10 @@ Base.@v_str
421435

422436
## Errors
423437

438+
```@docs
439+
Base.Experimental
440+
```
441+
424442
```@docs
425443
Base.error
426444
Core.throw
@@ -561,4 +579,10 @@ Meta.isoperator
561579
Meta.isunaryoperator
562580
Meta.isbinaryoperator
563581
Meta.show_sexpr
582+
Meta.parse(::AbstractString, ::Integer)
583+
Meta.replace_sourceloc!
584+
Meta.ispostfixoperator
585+
Base.operator_precedence
586+
Base.operator_associativity
587+
Base.remove_linenums!
564588
```

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: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,60 @@ Base.Filesystem.splitdir
6767
Base.Filesystem.splitdrive
6868
Base.Filesystem.splitext
6969
Base.Filesystem.splitpath
70+
Base.Filesystem.StatStruct
71+
Base.Filesystem.mktemp()
72+
Base.Filesystem.mktemp(::Any)
73+
Base.Filesystem.mktemp(::Function)
74+
Base.Filesystem.mktempdir()
75+
Base.setuid
76+
Base.setgid
77+
```
78+
79+
## File Open Flags
80+
81+
```@docs
82+
Base.Filesystem.JL_O_APPEND
83+
Base.Filesystem.JL_O_ASYNC
84+
Base.Filesystem.JL_O_CLOEXEC
85+
Base.Filesystem.JL_O_CREAT
86+
Base.Filesystem.JL_O_DIRECT
87+
Base.Filesystem.JL_O_DIRECTORY
88+
Base.Filesystem.JL_O_DSYNC
89+
Base.Filesystem.JL_O_EXCL
90+
Base.Filesystem.JL_O_FSYNC
91+
Base.Filesystem.JL_O_LARGEFILE
92+
Base.Filesystem.JL_O_NDELAY
93+
Base.Filesystem.JL_O_NOATIME
94+
Base.Filesystem.JL_O_NOCTTY
95+
Base.Filesystem.JL_O_NOFOLLOW
96+
Base.Filesystem.JL_O_NONBLOCK
97+
Base.Filesystem.JL_O_PATH
98+
Base.Filesystem.JL_O_RANDOM
99+
Base.Filesystem.JL_O_RDONLY
100+
Base.Filesystem.JL_O_RDWR
101+
Base.Filesystem.JL_O_RSYNC
102+
Base.Filesystem.JL_O_SEQUENTIAL
103+
Base.Filesystem.JL_O_SHORT_LIVED
104+
Base.Filesystem.JL_O_SYNC
105+
Base.Filesystem.JL_O_TEMPORARY
106+
Base.Filesystem.JL_O_TMPFILE
107+
Base.Filesystem.JL_O_TRUNC
108+
Base.Filesystem.JL_O_WRONLY
109+
```
110+
111+
## File Permissions
112+
113+
```@docs
114+
Base.Filesystem.S_IRUSR
115+
Base.Filesystem.S_IWUSR
116+
Base.Filesystem.S_IXUSR
117+
Base.Filesystem.S_IRWXU
118+
Base.Filesystem.S_IRGRP
119+
Base.Filesystem.S_IWGRP
120+
Base.Filesystem.S_IXGRP
121+
Base.Filesystem.S_IRWXG
122+
Base.Filesystem.S_IROTH
123+
Base.Filesystem.S_IWOTH
124+
Base.Filesystem.S_IXOTH
125+
Base.Filesystem.S_IRWXO
70126
```

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: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,11 @@ 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)
90+
Base.complex(::Real, ::Real)
8991
Base.bswap
9092
Base.hex2bytes
9193
Base.hex2bytes!
@@ -140,6 +142,8 @@ Base.leading_zeros
140142
Base.leading_ones
141143
Base.trailing_zeros
142144
Base.trailing_ones
145+
Base.bitreverse
146+
Base.mul_hi
143147
Base.isodd
144148
Base.iseven
145149
Base.@int128_str

doc/src/base/punctuation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,22 @@ 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.:=>
70+
Base.:∋(::Any, ::Any)
71+
Base.:∋(::Any)
72+
Base.:∌
73+
Base.:⊆
74+
Base.:⊇(::Any)
75+
Base.:⊇
76+
Base.:⊉(::Any)
77+
Base.:⊉
78+
Base.:⊋(::Any)
79+
Base.:⊋
80+
Base.:≉
81+
```

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)