Skip to content

Commit

Permalink
Specify the convenience method for List multiple assignment
Browse files Browse the repository at this point in the history
Add documentation and a example to specify and document List mulitple assignment.
  • Loading branch information
dlrobertson committed Aug 13, 2024
1 parent 283e1b6 commit dc49294
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions infra.bs
Original file line number Diff line number Diff line change
Expand Up @@ -1426,6 +1426,37 @@ out-of-bounds, except when used with <a for=list>exists</a>.
"<code>b</code>", "<code>c</code>", "<code>a</code>" ». Then |example|[1] is the <a>string</a>
"<code>b</code>".

<p>For notational convenience, a multiple assignment syntax may be used to assign multiple variables
to the <a>list</a>'s <a for=list>items</a>, by surrounding the variables to be assigned by « »
characters and separating each variable name with a comma. The <a>list</a>'s <a for=list>size</a>
must be the same as the number of variables to be assigned. Each variable given is then set to the
value of the <a>list</a>'s <a for=list>item</a> at the corresponding index.

<div class=example id=example-list-multiple-assignment>
<ol>
<li><p>Let |value| be the <a>list</a> « "<code>a</code>", "<code>b</code>", "<code>c</code>" ».

<li><p>Let « |a|, |b|, |c| » be |value|.

<li><p><a>Assert</a>: |a| is "<code>a</code>"

<li><p><a>Assert</a>: |b| is "<code>b</code>"

<li><p><a>Assert</a>: |c| is "<code>c</code>"
</ol>
</div>

<p>When a <a>list</a>'s contents are not fully controlled, as s the case for lists from user input,
the <a>list</a>'s <a for=list>size</a> should be checked to ensure it is the expected length before
list multiple assignment syntax is used.

<div class=example id=example-list-multiple-assignment-size>
<ol>
<li><p>If |list|'s <a for=list>size</a> is not <code>3</code>, then return failure.
<li><p>Let « |a|, |b|, |c| » be |value|.
</ol>
</div>

<hr>

<p>To <dfn export for=list>append</dfn> to a <a>list</a> that is not an <a>ordered set</a> is to
Expand Down

0 comments on commit dc49294

Please sign in to comment.