Documentation improvements (#3698)

Co-authored-by: PgBiel <9021226+PgBiel@users.noreply.github.com>
This commit is contained in:
Malo 2024-03-19 10:37:16 +01:00 committed by GitHub
parent 9dfc54d726
commit c125125080
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 9 deletions

View File

@ -223,8 +223,11 @@ impl Array {
self.0.pop().ok_or_else(array_is_empty)
}
/// Inserts a value into the array at the specified index. Fails with an
/// error if the index is out of bounds.
/// Inserts a value into the array at the specified index, shifting all
/// subsequent elements to the right. Fails with an error if the index is
/// out of bounds.
///
/// To replace an element of an array, use [`at`]($array.at).
#[func]
pub fn insert(
&mut self,

View File

@ -701,22 +701,22 @@ pub struct GridVLine {
///
/// #grid(
/// fill: (x, y) => rgb(
/// if calc.odd(x + y) { "EFF0F3" }
/// else { "7F8396" }
/// if calc.odd(x + y) { "7F8396" }
/// else { "EFF0F3" }
/// ),
/// columns: (1em,) * 8,
/// rows: 1em,
/// align: center + horizon,
///
/// [♜], [♞], [♝], [♛], [♚], [♝], [♞], [♜],
/// [♟], [♟], [♟], [♟], [], [♟], [♟], [♟],
/// [♖], [♘], [♗], [♕], [♔], [♗], [♘], [♖],
/// [♙], [♙], [♙], [♙], [], [♙], [♙], [♙],
/// grid.cell(
/// x: 4, y: 3,
/// stroke: blue.transparentize(60%)
/// )[],
/// )[],
///
/// ..(grid.cell(y: 6)[],) * 8,
/// ..([♖], [♘], [♗], [♕], [♔], [♗], [♘], [♖])
/// ..(grid.cell(y: 6)[],) * 8,
/// ..([♜], [♞], [♝], [♛], [♚], [♝], [♞], [♜])
/// .map(grid.cell.with(y: 7)),
/// )
/// ```