Update docs

This commit is contained in:
Bruce Hill 2024-09-11 14:59:42 -04:00
parent db0d5a1c20
commit c45afdabd5

View File

@ -345,11 +345,11 @@ A table mapping each element to its count.
### `find` ### `find`
**Description:** **Description:**
Finds the index of the first occurrence of an element. Finds the index of the first occurrence of an element (if any).
**Usage:** **Usage:**
```markdown ```markdown
find(arr: [T]) -> Int find(arr: [T]) -> Int?
``` ```
**Parameters:** **Parameters:**
@ -357,15 +357,15 @@ find(arr: [T]) -> Int
- `arr`: The array to search through. - `arr`: The array to search through.
**Returns:** **Returns:**
The index of the first occurrence or `0` if not found. The index of the first occurrence or `!Int` if not found.
**Example:** **Example:**
```markdown ```markdown
>> [10, 20, 30, 40, 50]:find(20) >> [10, 20, 30, 40, 50]:find(20)
= 2 = 2?
>> [10, 20, 30, 40, 50]:find(9999) >> [10, 20, 30, 40, 50]:find(9999)
= 0 = !Int
``` ```
--- ---
@ -373,7 +373,7 @@ The index of the first occurrence or `0` if not found.
### `first` ### `first`
**Description:** **Description:**
Find the first item that matches a predicate function. Find the index of the first item that matches a predicate function (if any).
**Usage:** **Usage:**
```markdown ```markdown
@ -387,15 +387,15 @@ first(arr: [T], predicate: func(item:&T)->Bool) -> Int
`no` if it should not. `no` if it should not.
**Returns:** **Returns:**
Returns a pointer to the first item that matches the given predicate, or null Returns the index of the first item where the predicate is true or `!Int` if no
if no match is found. item matches.
**Example:** **Example:**
```markdown ```markdown
when nums:find(func(i:&Int): i:is_prime()) is @prime: >> [4, 5, 6]:find(func(i:&Int): i:is_prime())
say("Got a prime: $prime") = 5?
else: >> [4, 6, 8]:find(func(i:&Int): i:is_prime())
say("No primes") = !Int
``` ```
--- ---