Skip to content

Commit

Permalink
docs/*: use the term built-in, not builtin
Browse files Browse the repository at this point in the history
Move the glossary and how-to guides (that deal with the built-in
functions mentioned in the spec) to use the term "built-in", rather than
"builtin". This does not (currently) align with the spec's usage, but
is the more correct English usage.

Preview-Path: /docs/howto/use-the-builtin-function-and/
Preview-Path: /docs/howto/use-the-builtin-function-close/
Preview-Path: /docs/howto/use-the-builtin-function-len/
Preview-Path: /docs/howto/use-the-builtin-function-or/
Preview-Path: /docs/howto/use-the-builtin-functions-div-mod-quo-rem/
Preview-Path: /docs/reference/glossary/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: Ic89c58f68271fb1085634f2b8814b636364b6cb1
Dispatch-Trailer: {"type":"trybot","CL":1175825,"patchset":3,"ref":"refs/changes/25/1175825/3","targetBranch":"alpha"}
  • Loading branch information
jpluscplusm authored and cueckoo committed Jan 23, 2024
1 parent a612189 commit 77c76dc
Show file tree
Hide file tree
Showing 27 changed files with 128 additions and 128 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin function "and" to unify the elements of a list
title: Using the built-in function "and" to unify the elements of a list
tags:
- language
- commented cue
Expand All @@ -10,9 +10,9 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
function
[`and()`]({{< relref "docs/reference/glossary#and-builtin-function" >}})
[`and()`]({{< relref "docs/reference/glossary#and-built-in-function" >}})
to unify all the elements of a list.

{{{with code "en" "cc"}}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package site
content: {
docs: {
howto: {
"use-the-builtin-function-and": {
"use-the-built-in-function-and": {
page: {
cache: {
code: {
Expand Down
3 changes: 3 additions & 0 deletions content/docs/howto/use-the-built-in-function-and/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: howto: "use-the-built-in-function-and": {}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin function "close" to close a struct
title: Using the built-in function "close" to close a struct
tags:
- language
- commented cue
Expand All @@ -10,9 +10,9 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
function
[`close()`]({{< relref "docs/reference/glossary#close-builtin-function" >}})
[`close()`]({{< relref "docs/reference/glossary#close-built-in-function" >}})
to close a
[struct]({{< relref "docs/reference/glossary#struct" >}}).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package site
content: {
docs: {
howto: {
"use-the-builtin-function-close": {
"use-the-built-in-function-close": {
page: {
cache: {
code: {
Expand Down
3 changes: 3 additions & 0 deletions content/docs/howto/use-the-built-in-function-close/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: howto: "use-the-built-in-function-close": {}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin function "len" to calculate lengths
title: Using the built-in function "len" to calculate lengths
tags:
- language
- commented cue
Expand All @@ -10,9 +10,9 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
function
[`len()`]({{< relref "docs/reference/glossary#len-builtin-function" >}})
[`len()`]({{< relref "docs/reference/glossary#len-built-in-function" >}})
to calculate the lengths of different CUE types.

{{{with code "en" "cc"}}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package site
content: {
docs: {
howto: {
"use-the-builtin-function-len": {
"use-the-built-in-function-len": {
page: {
cache: {
code: {
Expand Down
3 changes: 3 additions & 0 deletions content/docs/howto/use-the-built-in-function-len/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: howto: "use-the-built-in-function-len": {}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin function "or" to create a disjunction
title: Using the built-in function "or" to create a disjunction
tags:
- language
- commented cue
Expand All @@ -10,9 +10,9 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
function
[`or()`]({{< relref "docs/reference/glossary#or-builtin-function" >}})
[`or()`]({{< relref "docs/reference/glossary#or-built-in-function" >}})
to create a
[disjunction]({{< relref "docs/reference/glossary#disjunction" >}})
from a list.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package site
content: {
docs: {
howto: {
"use-the-builtin-function-or": {
"use-the-built-in-function-or": {
page: {
cache: {
code: {
Expand Down
3 changes: 3 additions & 0 deletions content/docs/howto/use-the-built-in-function-or/page.cue
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: howto: "use-the-built-in-function-or": {}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin functions "div", "mod", "quo", and "rem"
title: Using the built-in functions "div", "mod", "quo", and "rem"
tags:
- language
- commented cue
Expand All @@ -10,17 +10,17 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
functions
[`div()`]({{< relref "docs/reference/glossary#div-builtin-function" >}})
[`div()`]({{< relref "docs/reference/glossary#div-built-in-function" >}})
and
[`mod()`]({{< relref "docs/reference/glossary#mod-builtin-function" >}})
[`mod()`]({{< relref "docs/reference/glossary#mod-built-in-function" >}})
to perform
[Euclidean division](https://en.wikipedia.org/wiki/Euclidean_division),
and how to use
[`quo()`]({{< relref "docs/reference/glossary#quo-builtin-function" >}})
[`quo()`]({{< relref "docs/reference/glossary#quo-built-in-function" >}})
and
[`rem()`]({{< relref "docs/reference/glossary#rem-builtin-function" >}})
[`rem()`]({{< relref "docs/reference/glossary#rem-built-in-function" >}})
to perform truncated division.

The behaviours of these functions are defined in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package site
content: {
docs: {
howto: {
"use-the-builtin-functions-div-mod-quo-rem": {
"use-the-built-in-functions-div-mod-quo-rem": {
page: {
cache: {
code: {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
package site

content: docs: howto: "use-the-built-in-functions-div-mod-quo-rem": {}
3 changes: 0 additions & 3 deletions content/docs/howto/use-the-builtin-function-and/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/howto/use-the-builtin-function-close/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/howto/use-the-builtin-function-len/page.cue

This file was deleted.

3 changes: 0 additions & 3 deletions content/docs/howto/use-the-builtin-function-or/page.cue

This file was deleted.

This file was deleted.

72 changes: 36 additions & 36 deletions content/docs/reference/glossary/en.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ toc_hide: false

{{< step group="glossary" stepNumber="A" >}}

## `and()` {#and-builtin-function}
## `and()` {#and-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#and" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-function-and" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that accepts a list
and returns the unification of all elements in the list
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-function-and" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that accepts a
list and returns the unification of all elements in the list

{{< /step >}}

Expand All @@ -21,17 +21,17 @@ toc_hide: false
- A primitive [type]({{< relref "#type" >}}) representing the set of Boolean
truth values denoted by the keywords `true` and `false`

## Builtin functions
🔗 [Language Spec]({{< relref "docs/reference/spec#builtin-functions" >}})
## Built-in functions
🔗 [Language Spec]({{< relref "docs/reference/spec#built-in-functions" >}})
| *e.g.*
[`and()`]({{< relref "#and-builtin-function" >}})
/ [`close()`]({{< relref "#close-builtin-function" >}})
/ [`div()`]({{< relref "#div-builtin-function" >}})
/ [`mod()`]({{< relref "#mod-builtin-function" >}})
/ [`len()`]({{< relref "#len-builtin-function" >}})
/ [`or()`]({{< relref "#or-builtin-function" >}})
/ [`quo()`]({{< relref "#quo-builtin-function" >}})
/ [`rem()`]({{< relref "#rem-builtin-function" >}})
[`and()`]({{< relref "#and-built-in-function" >}})
/ [`close()`]({{< relref "#close-built-in-function" >}})
/ [`div()`]({{< relref "#div-built-in-function" >}})
/ [`mod()`]({{< relref "#mod-built-in-function" >}})
/ [`len()`]({{< relref "#len-built-in-function" >}})
/ [`or()`]({{< relref "#or-built-in-function" >}})
/ [`quo()`]({{< relref "#quo-built-in-function" >}})
/ [`rem()`]({{< relref "#rem-built-in-function" >}})
- Predeclared functions provided by the CUE runtime that are available without
being imported

Expand All @@ -46,10 +46,10 @@ toc_hide: false

{{< step group="glossary" stepNumber="C" >}}

## `close()` {#close-builtin-function}
## `close()` {#close-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#close" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-function-close" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that converts a
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-function-close" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that converts a
partially defined ("open") struct to a fully defined ("closed") struct

<!-- TODO ## Closed -->
Expand All @@ -70,10 +70,10 @@ toc_hide: false
| [Tour #1]({{< relref "docs/tour/types/disjunctions" >}})
| [Tour #2]({{< relref "docs/tour/types/sumstruct" >}})

## `div()` {#div-builtin-function}
## `div()` {#div-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#div-mod-quo-and-rem" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-functions-div-mod-quo-rem" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that performs
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-functions-div-mod-quo-rem" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that performs
Euclidean division with its parameters and returns the integer quotient

{{< /step >}}
Expand Down Expand Up @@ -138,10 +138,10 @@ toc_hide: false

{{< step group="glossary" stepNumber="L" >}}

## `len()` {#len-builtin-function}
## `len()` {#len-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#len" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-function-len" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that returns the
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-function-len" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that returns the
lengths of various types as an integer

## List
Expand All @@ -155,10 +155,10 @@ toc_hide: false

{{< step group="glossary" stepNumber="M" >}}

## `mod()` {#mod-builtin-function}
## `mod()` {#mod-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#div-mod-quo-and-rem" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-functions-div-mod-quo-rem" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that performs
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-functions-div-mod-quo-rem" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that performs
Euclidean division with its parameters and returns the integer remainder

<!-- TODO ## Module -->
Expand Down Expand Up @@ -194,11 +194,11 @@ toc_hide: false
field's value if the field is present, whilst also permitting the field's
absence

## `or()` {#or-builtin-function}
## `or()` {#or-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#or" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-function-or" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that accepts a list
and produces a [disjunction]({{< relref "#disjunction" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-function-or" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that accepts a
list and produces a [disjunction]({{< relref "#disjunction" >}})

{{< /step >}}

Expand All @@ -210,10 +210,10 @@ toc_hide: false

{{< step group="glossary" stepNumber="Q" >}}

## `quo()` {#quo-builtin-function}
## `quo()` {#quo-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#div-mod-quo-and-rem" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-functions-div-mod-quo-rem" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that performs
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-functions-div-mod-quo-rem" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that performs
truncated division with its parameters and returns the integer quotient

{{< /step >}}
Expand All @@ -228,10 +228,10 @@ toc_hide: false
number of hashes on both sides, allowing escape sequences to appear inside
the text verbatim, without their usual escaping taking effect

## `rem()` {#rem-builtin-function}
## `rem()` {#rem-built-in-function}
🔗 [Language Spec]({{< relref "docs/reference/spec#div-mod-quo-and-rem" >}})
| [Howto Guide]({{< relref "docs/howto/use-the-builtin-functions-div-mod-quo-rem" >}})
- A [builtin function]({{< relref "#builtin-functions" >}}) that performs
| [Howto Guide]({{< relref "docs/howto/use-the-built-in-functions-div-mod-quo-rem" >}})
- A [built-in function]({{< relref "#built-in-functions" >}}) that performs
truncated division with its parameters and returns the integer remainder

## Required field constraint
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin function "and" to unify the elements of a list
title: Using the built-in function "and" to unify the elements of a list
tags:
- language
- commented cue
Expand All @@ -10,9 +10,9 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
function
[`and()`]({{< relref "docs/reference/glossary#and-builtin-function" >}})
[`and()`]({{< relref "docs/reference/glossary#and-built-in-function" >}})
to unify all the elements of a list.

{{< code-tabs >}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin function "close" to close a struct
title: Using the built-in function "close" to close a struct
tags:
- language
- commented cue
Expand All @@ -10,9 +10,9 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
function
[`close()`]({{< relref "docs/reference/glossary#close-builtin-function" >}})
[`close()`]({{< relref "docs/reference/glossary#close-built-in-function" >}})
to close a
[struct]({{< relref "docs/reference/glossary#struct" >}}).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Using the builtin function "len" to calculate lengths
title: Using the built-in function "len" to calculate lengths
tags:
- language
- commented cue
Expand All @@ -10,9 +10,9 @@ toc_hide: true

This [Commented CUE]({{< relref "docs/howto#commented-cue-guides" >}})
demonstrates how to use the
[builtin]({{< relref "docs/reference/glossary#builtin-functions" >}})
[built-in]({{< relref "docs/reference/glossary#built-in-functions" >}})
function
[`len()`]({{< relref "docs/reference/glossary#len-builtin-function" >}})
[`len()`]({{< relref "docs/reference/glossary#len-built-in-function" >}})
to calculate the lengths of different CUE types.

{{< code-tabs >}}
Expand Down
Loading

0 comments on commit 77c76dc

Please sign in to comment.