Skip to content

Commit

Permalink
docs: streamline series wording (#242)
Browse files Browse the repository at this point in the history
  • Loading branch information
yamcodes authored Jan 5, 2025
1 parent e82d2f5 commit 6cac3dd
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/series/series.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ since: 12.1.0

### Usage

Sometimes you have an enum or union type, possibly a status, that has an inherent order and you need to work with values as though they're ordered. The `series` function takes many values and returns an object that let's you do ordered logic on those values.
The series function allows you to work with ordered values from an enum or union type, such as a status, by returning an object for performing ordered logic.

```ts
import * as _ from 'radashi'
Expand Down Expand Up @@ -34,7 +34,7 @@ weekdays.spin('monday', 3) // => 'thursday'

### Complex Data Types

When working with objects you'll want to provide a second argument to `series`, a function that converts non-primitive values into an identity that can be checked for equality.
For objects, pass a second argument to `series`: a function that converts non-primitive values into an identity that can be checked for equality.

```ts
import * as _ from 'radashi'
Expand Down

0 comments on commit 6cac3dd

Please sign in to comment.