Skip to content

Commit

Permalink
chore: Correct wording in make
Browse files Browse the repository at this point in the history
  • Loading branch information
spotandjake committed Nov 18, 2024
1 parent 2e73539 commit 42b6a49
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
3 changes: 2 additions & 1 deletion stdlib/queue.gr
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ abstract record Queue<a> {
/**
* Creates a new queue with an initial storage of the given size. As values are
* added or removed, the internal storage may grow or shrink. Generally, you
* won’t need to care about the storage size of your map and can use the
* won’t need to care about the storage size of your queue and can use the
* default size.
*
* @param size: The initial storage size of the queue
* @returns An empty queue
*
* @example Queue.make() // Creates a new queue
* @example Queue.make(size=16) // Creates a new queue with an initial size of 16
*
* @since v0.6.0
*/
Expand Down
6 changes: 5 additions & 1 deletion stdlib/queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ make : (?size: Number) => Queue<a>

Creates a new queue with an initial storage of the given size. As values are
added or removed, the internal storage may grow or shrink. Generally, you
won’t need to care about the storage size of your map and can use the
won’t need to care about the storage size of your queue and can use the
default size.

Parameters:
Expand All @@ -75,6 +75,10 @@ Examples:
Queue.make() // Creates a new queue
```

```grain
Queue.make(size=16) // Creates a new queue with an initial size of 16
```

### Queue.**isEmpty**

<details disabled>
Expand Down

0 comments on commit 42b6a49

Please sign in to comment.