a76a424 · urbit.org · git.iko.soy

git.iko.soy/urbit.org

on master help sign in

Add docs to library docs 1a-2a

a76a424Alec Brickner6 years ago

hoon/reference/stdlib/1a.md+34−34

compare with master

unifiedsplit

@@ -12,13 +12,13 @@ Produces the sum of `a` and `b`.

13#### Accepts

15−`a` is an atom.

15+`a` is an [`atom`](@/docs/glossary/atom.md).

17−`b` is an atom.

17+`b` is an [`atom`](@/docs/glossary/atom.md).

19#### Produces

21−An atom.

21+An [`atom`](@/docs/glossary/atom.md).

23#### Source

@@ -65,11 +65,11 @@ Decrements `a` by `1`.

66#### Accepts

68−`a` is an atom.

68+`a` is an [`atom`](@/docs/glossary/atom.md).

70#### Produces

72−An atom.

72+An [`atom`](@/docs/glossary/atom.md).

74#### Source

@@ -116,13 +116,13 @@ Computes `a` divided by `b` without remainder.

116

117#### Accepts

118

119−`a` is an atom.

119+`a` is an [`atom`](@/docs/glossary/atom.md).

120

121−`b` is an atom.

121+`b` is an [`atom`](@/docs/glossary/atom.md).

122

123#### Produces

124

125−An atom.

125+An [`atom`](@/docs/glossary/atom.md).

126

127#### Source

128

@@ -171,13 +171,13 @@ Computes `a` divided by `b`, producing the quotient and the remainder.

171

172#### Accepts

173

174−`a` is an atom.

174+`a` is an [`atom`](@/docs/glossary/atom.md).

175

176−`b` is an atom.

176+`b` is an [`atom`](@/docs/glossary/atom.md).

177

178#### Produces

179

180−A cell of atoms.

180+A cell of [`atoms`](@/docs/glossary/atom.md).

181

182#### Source

183

@@ -221,9 +221,9 @@ Tests whether `a` is greater than or equal to `b`.

221

222#### Accepts

223

224−`a` is an atom.

224+`a` is an [`atom`](@/docs/glossary/atom.md).

225

226−`b` is an atom.

226+`b` is an [`atom`](@/docs/glossary/atom.md).

227

228#### Produces

229

@@ -261,9 +261,9 @@ Tests whether `a` is greater than `b`.

261

262#### Accepts

263

264−`a` is an atom.

264+`a` is an [`atom`](@/docs/glossary/atom.md).

265

266−`b` is an atom.

266+`b` is an [`atom`](@/docs/glossary/atom.md).

267

268#### Produces

269

@@ -302,9 +302,9 @@ Tests whether `a` is less than or equal to `b`.

302

303#### Accepts

304

305−`a` is an atom.

305+`a` is an [`atom`](@/docs/glossary/atom.md).

306

307−`b` is an atom.

307+`b` is an [`atom`](@/docs/glossary/atom.md).

308

309#### Produces

310

@@ -359,9 +359,9 @@ Tests whether `a` is less than `b`.

359

360#### Accepts

361

362−`a` is an atom.

362+`a` is an [`atom`](@/docs/glossary/atom.md).

363

364−`b` is an atom.

364+`b` is an [`atom`](@/docs/glossary/atom.md).

365

366#### Produces

367

@@ -417,13 +417,13 @@ Computes the greater of `a` and `b`.

417

418#### Accepts

419

420−`a` is an atom.

420+`a` is an [`atom`](@/docs/glossary/atom.md).

421

422−`b` is an atom.

422+`b` is an [`atom`](@/docs/glossary/atom.md).

423

424#### Produces

425

426−An atom.

426+An [`atom`](@/docs/glossary/atom.md).

427

428#### Source

429

@@ -473,13 +473,13 @@ Computes the lesser of `a` and `b`.

473

474#### Accepts

475

476−`a` is an atom.

476+`a` is an [`atom`](@/docs/glossary/atom.md).

477

478−`b` is an atom.

478+`b` is an [`atom`](@/docs/glossary/atom.md).

479

480#### Produces

481

482−An atom.

482+An [`atom`](@/docs/glossary/atom.md).

483

484#### Source

485

@@ -527,13 +527,13 @@ Computes the remainder of dividing `a` by `b`.

527

528#### Accepts

529

530−`a` is an atom.

530+`a` is an [`atom`](@/docs/glossary/atom.md).

531

532−`b` is an atom.

532+`b` is an [`atom`](@/docs/glossary/atom.md).

533

534#### Produces

535

536−An atom.

536+An [`atom`](@/docs/glossary/atom.md).

537

538#### Source

539

@@ -578,13 +578,13 @@ Multiplies `a` by `b`.

578

579#### Accepts

580

581−`a` is an atom.

581+`a` is an [`atom`](@/docs/glossary/atom.md).

582

583−`b` is an atom.

583+`b` is an [`atom`](@/docs/glossary/atom.md).

584

585#### Produces

586

587−An atom.

587+An [`atom`](@/docs/glossary/atom.md).

588

589#### Source

590

@@ -629,13 +629,13 @@ Subtracts `b` from `a`.

629

630#### Accepts

631

632−`a` is an atom.

632+`a` is an [`atom`](@/docs/glossary/atom.md).

633

634−`b` is an atom.

634+`b` is an [`atom`](@/docs/glossary/atom.md).

635

636#### Produces

637

638−An atom.

638+An [`atom`](@/docs/glossary/atom.md).

639

640#### Source

641

hoon/reference/stdlib/1b.md+14−14

@@ -11,18 +11,18 @@ information on the tree-addressing system.

12Tree head

14−Tests whether the tree address `a` is in the head or the tail of a noun.

14+Tests whether the tree address `a` is in the head or the tail of a [`noun`](@/docs/glossary/noun.md).

15−Produces the constant atom `%2` if it is within the head (subtree `+2`), or

15+Produces the constant [`atom`](@/docs/glossary/atom.md) `%2` if it is within the head (subtree `+2`), or

16−the constant atom `%3` if it is within the tail (subtree `+3`).

16+the constant [`atom`](@/docs/glossary/atom.md) `%3` if it is within the tail (subtree `+3`).

19#### Accepts

21−`a` is an atom.

21+`a` is an [`atom`](@/docs/glossary/atom.md).

23#### Produces

25−A constant atom.

25+A constant [`atom`](@/docs/glossary/atom.md).

27#### Source

@@ -70,16 +70,16 @@ A constant atom.

71Address within head/tail

73−Computes the tree address of atom `a` within either the head (`+2`) or tail

73+Computes the tree address of [`atom`](@/docs/glossary/atom.md) `a` within either the head (`+2`) or tail

74−(`+3`) of a noun.

74+(`+3`) of a [`noun`](@/docs/glossary/noun.md).

76#### Accepts

78−`a` is an atom.

78+`a` is an [`atom`](@/docs/glossary/atom.md).

80#### Produces

82−An atom.

82+An [`atom`](@/docs/glossary/atom.md).

84#### Source

@@ -144,7 +144,7 @@ An atom.

144 (continues...)

145```

146

147−Running `(mas 7)` in the Dojo will return `3`, because address `+3` is what

147+Running `(mas 7)` in the [`Dojo`](@/docs/glossary/dojo.md) will return `3`, because address `+3` is what

148`+7` now occupies. The tree below helps illustrate the relationship. With

149parentheses are `a` values (if `a` is in subtree `+3`), and without parentheses

150are the values returned with `(mas a)`.

@@ -175,13 +175,13 @@ Computes the absolute address of `b`, a relative address within the subtree

175

176#### Accepts

177

178−`a` is an atom.

178+`a` is an [`atom`](@/docs/glossary/atom.md).

179

180−`b` is an atom.

180+`b` is an [`atom`](@/docs/glossary/atom.md).

181

182#### Produces

183

184−An atom.

184+An [`atom`](@/docs/glossary/atom.md).

185

186#### Source

187

@@ -232,7 +232,7 @@ right (starting with root `+1`, head `+2`, and tail `+3`). Relative address

232`b` is found with respect to `a`, and then its absolute address, within the

233greater tree, is returned.

234

235−Running `(peg 3 4)` in the Dojo, for example, will return `12`. Looking at

235+Running `(peg 3 4)` in the [`Dojo`](@/docs/glossary/dojo.md), for example, will return `12`. Looking at

236a tree diagram makes it easy to see why.

237

238```

hoon/reference/stdlib/1c.md+12−12

@@ -8,7 +8,7 @@ template = "doc.html"

9Blocksize

11−Atom representing block size. A block of size `a` has a bitwidth of `2^a`.

11+[`Atom`](@/docs/glossary/atom.md) representing block size. A block of size `a` has a bitwidth of `2^a`.

13#### Source

@@ -97,7 +97,7 @@ A mold generator. Produces a discriminated fork between two types, defaulting to

98Function

100−A core with one arm, `$`--the empty name--which transforms a sample noun into a

100+A [`core`](@/docs/glossary/core.md) with one arm, `$`--the empty name--which transforms a sample noun into a

101product noun. If used dryly as a type, the subject must have a sample type of

102`*`.

103

@@ -130,7 +130,7 @@ A `gate` is analogous to a function in other programming languages. We created

130this new jargon because other constructs in Urbit are "functions" in the

131mathematical sense. Any `gate` normalizes to an iron `gate`.

132

133−See also: [`++lift`](../2a), [`++cork`](../2n)

133+See also: [`++lift`](@/docs/hoon/reference/stdlib/2a.md#lift), [`++cork`](@/docs/hoon/reference/stdlib/2n.md#cork)

134

135---

136### `++list`

@@ -166,7 +166,7 @@ homogenous type.

166```

167#### Discussion

168

169−See also: [`++turn`](../2b), [`++snag`](../2b)

169+See also: [`++turn`](@/docs/hoon/reference/stdlib/2b.md#turn), [`++snag`](@/docs/hoon/reference/stdlib/2b.md#snag)

170

171---

172### `++lone`

@@ -229,9 +229,9 @@ A mold generator. Produces a tuple of two of the types passed in.

229---

230### `++pole`

231

232−Faceless list

232+Faceless [`list`](@/docs/hoon/reference/stdlib/1c.md#list)

233

234−A mold generator. A `list` without the faces `i` and `t`.

234+A mold generator. A [`list`](@/docs/hoon/reference/stdlib/1c.md#list) without the faces `i` and `t`.

235

236#### Source

237

@@ -280,9 +280,9 @@ A mold generator. Produces a tuple of four of the types passed in.

280---

281### `++quip`

282

283−Mold of pair of `list` and type

283+Mold of pair of [`list`](@/docs/hoon/reference/stdlib/1c.md#list) and type

284

285−A mold generator. Produces a tuple of a `list` of `a` and the mold of `b`.

285+A mold generator. Produces a tuple of a [`list`](@/docs/hoon/reference/stdlib/1c.md#list) of `a` and the mold of `b`.

286

287#### Source

288

@@ -309,9 +309,9 @@ new state. You'll often see `quip` used in Gall apps.

309---

310### `++trap`

311

312−Core with one arm `$`

312+[`Core`](@/docs/glossary/core.md) with one arm `$`

313

314−A trap is a core with one arm `$`.

314+A trap is a [`core`](@/docs/glossary/core.md) with one arm `$`.

315

316#### Source

317

@@ -416,6 +416,6 @@ type that was passed in.

416

417Using a `unit` allows you to specify something that may not be there.

418

419−See also: [`++bind`](../2b)

419+See also: [`++bind`](@/docs/hoon/reference/stdlib/2a.md#bind)

420

421−---

421+---

hoon/reference/stdlib/2a.md+50−50

@@ -6,20 +6,20 @@ template = "doc.html"

7### `++biff`

9−Unit as argument

9+[`Unit`](@/docs/hoon/reference/stdlib/1c.md#unit) as argument

11−Applies a function `b` that produces a unit to the unwrapped value of ++unit

11+Applies a function `b` that produces a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) to the unwrapped value of [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit)

12`a` (`u.a`). If `a` is empty, `~` is produced.

14#### Accepts

16−`a` is a unit.

16+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

18−`b` is a function that accepts a noun and produces a unit.

18+`b` is a function that accepts a [`noun`](@/docs/glossary/noun.md) and produces a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

20#### Produces

22−A unit.

22+A [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

24#### Source

@@ -44,21 +44,21 @@ A unit.

44---

45### `++bind`

47−Non-unit function to unit, producing unit

47+Non-unit function to [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit), producing [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit)

49−Applies a function `b` to the value (`u.a`) of a ++unit `a`, producing

49+Applies a function `b` to the value (`u.a`) of a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) `a`, producing

50−a unit. Used when you want a function that does not accept or produce a

50+a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit). Used when you want a function that does not accept or produce a

51−unit to both accept and produce a unit.

51+[`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) to both accept and produce a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

53#### Accepts

55−`a` is a unit.

55+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

57`b` is a function.

59#### Produces

61−A unit.

61+A [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

63#### Source

@@ -87,18 +87,18 @@ A unit.

88Replace null

90−Replaces an empty ++unit `b` with the product of a called trap

90+Replaces an empty [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) `b` with the product of a called [`trap`](@/docs/glossary/trap.md)

91−`a`. If the unit is not empty, then the original unit is produced.

91+`a`. If the [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) is not empty, then the original [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) is produced.

93#### Accepts

95−`a` is a trap.

95+`a` is a [`trap`](@/docs/glossary/trap.md).

97−`b` is a unit.

97+`b` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

99#### Produces

100

101−Either the product of `a` or the value inside of unit `b`.

101+Either the product of `a` or the value inside of [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) `b`.

102

103#### Source

104

@@ -126,21 +126,21 @@ Either the product of `a` or the value inside of unit `b`.

126---

127### `++both`

128

129−Group unit values into pair

129+Group [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) values into pair

130

131Produces `~` if either `a` or `b` are empty. Otherwise, produces a

132−++unit whose value is a cell of the values of two input units `a` and

132+[`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) whose value is a cell of the values of two input [`units`](@/docs/hoon/reference/stdlib/1c.md#unit) `a` and

133`b`.

134

135#### Accepts

136

137−`a` is a unit.

137+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

138

139−`b` is a unit.

139+`b` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

140

141#### Produces

142

143−A unit of the two initial values.

143+A [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) of the two initial values.

144

145#### Source

146

@@ -165,22 +165,22 @@ A unit of the two initial values.

165---

166### `++clap`

167

168−Apply function to two units

168+Apply function to two [`units`](@/docs/hoon/reference/stdlib/1c.md#unit)

169

170Applies a binary function `c`--which does not usually accept or produce a

171−`++unit`-- to the values of two units, `a` and `b`, producing a unit.

171+[`unit`](@/docs/hoon/reference/stdlib/1c.md#unit)-- to the values of two [`units`](@/docs/hoon/reference/stdlib/1c.md#unit), `a` and `b`, producing a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

172

173#### Accepts

174

175−`a` is a unit.

175+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

176

177−`b` is a unit.

177+`b` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

178

179`c` is a function that performs a binary operation.

180

181#### Produces

182

183−A unit.

183+A [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

184

185#### Source

186

@@ -212,13 +212,13 @@ A unit.

212---

213### `++drop`

214

215−Unit to list

215+[`Unit`](@/docs/hoon/reference/stdlib/1c.md#unit) to list

216

217−Makes a ++list of the unwrapped value (`u.a`) of a `++unit` `a`.

217+Makes a [`++list`](@/docs/hoon/reference/stdlib/1c.md#list) of the unwrapped value (`u.a`) of a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) `a`.

218

219#### Accepts

220

221−`a` is a unit.

221+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

222

223#### Produces

224

@@ -249,19 +249,19 @@ A list.

249---

250### `++fall`

251

252−Give unit a default value

252+Give [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) a default value

253

254−Produces a default value `b` for a `++unit` `a` in cases where `a` is null.

254+Produces a default value `b` for a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) `a` in cases where `a` is null.

255

256#### Accepts

257

258−`a` is a unit.

258+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

259

260−`b` is a noun that's used as the default value.

260+`b` is a [`noun`](@/docs/glossary/noun.md) that's used as the default value.

261

262#### Produces

263

264−Either a noun `b` or the unwrapped value of unit `a`.

264+Either a [`noun`](@/docs/glossary/noun.md) `b` or the unwrapped value of [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) `a`.

265

266#### Source

267

@@ -285,19 +285,19 @@ Either a noun `b` or the unwrapped value of unit `a`.

285

286Curried bind

287

288−Accepts a `++gate` `a` and produces a function that accepts `++unit`

288+Accepts a `++gate` `a` and produces a function that accepts [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit)

289`b` to which it applies `a`. Used when you want a function that does not accept

290−or produce a unit to both accept and produce a unit.

290+or produce a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) to both accept and produce a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

291

292#### Accepts

293

294`a` is a gate.

295

296−`b` is a unit.

296+`b` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

297

298#### Produces

299

300−A unit.

300+A [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

301

302#### Source

303

@@ -324,7 +324,7 @@ A unit.

324

325Choose

326

327−Accepts two units `a` and `b` whose values are expected to be

327+Accepts two [`units`](@/docs/hoon/reference/stdlib/1c.md#unit) `a` and `b` whose values are expected to be

328equivalent. If either is empty, then the value of the other is produced.

329If neither are empty, it asserts that both values are the same and

330produces that value. If the assertion fails, `++mate` crashes with

@@ -332,13 +332,13 @@ produces that value. If the assertion fails, `++mate` crashes with

332

333#### Accepts

334

335−`a` is a unit.

335+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

336

337−`b` is a unit.

337+`b` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

338

339#### Produces

340

341−A unit or crash.

341+A [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) or crash.

342

343#### Source

344

@@ -374,13 +374,13 @@ A unit or crash.

374---

375### `++need`

376

377−Unwrap unit

377+Unwrap [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit)

378

379−Retrieve the value from a `++unit` and crash if the unit is null.

379+Retrieve the value from a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) and crash if the [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) is null.

380

381#### Accepts

382

383−`a` is a unit.

383+`a` is a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

384

385#### Produces

386

@@ -415,17 +415,17 @@ Either the unwrapped value of `a` (`u.a`), or crash.

415---

416### `++some`

417

418−Wrap value in a unit

418+Wrap value in a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit)

419

420−Takes any noun `a` and produces a `++unit` with the value set to `a`.

420+Takes any [`noun`](@/docs/glossary/noun.md) `a` and produces a [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit) with the value set to `a`.

421

422#### Accepts

423

424−`a` is a noun.

424+`a` is a [`noun`](@/docs/glossary/noun.md).

425

426#### Produces

427

428−A unit.

428+A [`unit`](@/docs/hoon/reference/stdlib/1c.md#unit).

429

430#### Source

431

@@ -446,4 +446,4 @@ A unit.

446```

447

448

449−---

449+---