Skip to content

Commit f33bb02

Browse files
authored
std: clean up top-level namespaces documentation
This cleans up existing documentation, adds a bit more, and fixes some typos too.
1 parent 39a98dc commit f33bb02

File tree

1 file changed

+31
-18
lines changed

1 file changed

+31
-18
lines changed

lib/std/std.zig

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,21 @@ pub const Uri = @import("Uri.zig");
5454

5555
pub const array_hash_map = @import("array_hash_map.zig");
5656

57-
/// Memory ordering, atomic data structures and operations.
57+
/// Memory ordering, atomic data structures, and operations.
5858
pub const atomic = @import("atomic.zig");
5959

60-
/// Base64 encoding / decoding.
60+
/// Base64 encoding/decoding.
6161
pub const base64 = @import("base64.zig");
6262

63-
/// Bit-fiddling data structures.
63+
/// Bit manipulation data structures.
6464
pub const bit_set = @import("bit_set.zig");
6565

66-
/// Comptime-available information about the target machine and build mode.
66+
/// Comptime-available information about the build environment, such as the target and optimize mode.
6767
pub const builtin = @import("builtin.zig");
6868

6969
pub const c = @import("c.zig");
70+
71+
/// COFF format.
7072
pub const coff = @import("coff.zig");
7173

7274
/// Compression algorithms such as zlib, zstd, etc.
@@ -79,7 +81,11 @@ pub const cstr = @import("cstr.zig");
7981

8082
/// Debug printing, allocation and other debug helpers.
8183
pub const debug = @import("debug.zig");
84+
85+
/// DWARF debugging data format.
8286
pub const dwarf = @import("dwarf.zig");
87+
88+
/// ELF format.
8389
pub const elf = @import("elf.zig");
8490

8591
/// Enum-related metaprogramming helpers.
@@ -88,15 +94,16 @@ pub const enums = @import("enums.zig");
8894
/// Evented I/O data structures.
8995
pub const event = @import("event.zig");
9096

97+
/// First in, first out data structures.
9198
pub const fifo = @import("fifo.zig");
9299

93-
/// String formatting and parsing (eg parsing numbers out of strings).
100+
/// String formatting and parsing (e.g. parsing numbers out of strings).
94101
pub const fmt = @import("fmt.zig");
95102

96-
/// File-system related types.
103+
/// File system-related functionality.
97104
pub const fs = @import("fs.zig");
98105

99-
/// Fast hashing functions (i.e. not cryptographically secure)
106+
/// Fast hashing functions (i.e. not cryptographically secure).
100107
pub const hash = @import("hash.zig");
101108
pub const hash_map = @import("hash_map.zig");
102109

@@ -106,21 +113,25 @@ pub const heap = @import("heap.zig");
106113
/// HTTP client and server.
107114
pub const http = @import("http.zig");
108115

109-
/// I/O Streams, Reader/Writer interfaces and common helpers.
116+
/// I/O streams, reader/writer interfaces and common helpers.
110117
pub const io = @import("io.zig");
111118

112119
/// JSON parsing and serialization.
113120
pub const json = @import("json.zig");
121+
122+
/// LEB128 encoding.
114123
pub const leb = @import("leb128.zig");
115124

116125
/// A standardized interface for logging.
117126
pub const log = @import("log.zig");
127+
128+
/// Mach-O format.
118129
pub const macho = @import("macho.zig");
119130

120131
/// Mathematical constants and operations.
121132
pub const math = @import("math.zig");
122133

123-
/// Functions for comparing, searching and manipulating memory.
134+
/// Functions for comparing, searching, and manipulating memory.
124135
pub const mem = @import("mem.zig");
125136

126137
/// Metaprogramming helpers.
@@ -137,13 +148,14 @@ pub const once = @import("once.zig").once;
137148
/// A set of array and slice types that bit-pack integer elements.
138149
pub const packed_int_array = @import("packed_int_array.zig");
139150

151+
/// PDB file format.
140152
pub const pdb = @import("pdb.zig");
141153

142154
/// Accessors for process-related info (e.g. command line arguments)
143-
/// aand spawning of child processes.
155+
/// and spawning of child processes.
144156
pub const process = @import("process.zig");
145157

146-
/// Fast pseudo-random number generators (i.e. non-cryptographically secure).
158+
/// Fast pseudo-random number generators (i.e. not cryptographically secure).
147159
pub const rand = @import("rand.zig");
148160

149161
/// Sorting.
@@ -152,32 +164,33 @@ pub const sort = @import("sort.zig");
152164
/// Single Instruction Multiple Data (SIMD) helpers.
153165
pub const simd = @import("simd.zig");
154166

155-
/// ASCII text manipulation.
167+
/// ASCII text processing.
156168
pub const ascii = @import("ascii.zig");
157169

158-
/// Tar archive format compression / decompression.
170+
/// Tar archive format compression/decompression.
159171
pub const tar = @import("tar.zig");
160172

161173
/// Testing allocator, testing assertions, and other helpers for testing code.
162174
pub const testing = @import("testing.zig");
163175

164-
/// Sleep, obtaining the current time and constants for conversions.
176+
/// Sleep, obtaining the current time, conversion constants, and more.
165177
pub const time = @import("time.zig");
166178

167-
/// Timezones.
179+
/// Time zones.
168180
pub const tz = @import("tz.zig");
169181

170-
/// UTF8 and UTF16LE ecoding / decoding.
182+
/// UTF-8 and UTF-16LE encoding/decoding.
171183
pub const unicode = @import("unicode.zig");
172184

173185
/// Helpers for integrating with Valgrind.
174186
pub const valgrind = @import("valgrind.zig");
175187

176-
/// Constants and types representing the WASM binary format.
188+
/// Constants and types representing the Wasm binary format.
177189
pub const wasm = @import("wasm.zig");
178190

179191
/// Tokenizing and parsing of Zig code and other Zig-specific language tooling.
180192
pub const zig = @import("zig.zig");
193+
181194
pub const start = @import("start.zig");
182195

183196
/// deprecated: use `Build`.
@@ -193,7 +206,7 @@ pub const options = struct {
193206
else
194207
debug.default_enable_segfault_handler;
195208

196-
/// Function used to implement std.fs.cwd for wasi.
209+
/// Function used to implement `std.fs.cwd` for WASI.
197210
pub const wasiCwd: fn () fs.Dir = if (@hasDecl(options_override, "wasiCwd"))
198211
options_override.wasiCwd
199212
else

0 commit comments

Comments
 (0)