Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: streamline series wording #242

Merged
merged 1 commit into from
Jan 5, 2025
Merged

docs: streamline series wording #242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/series/series.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Create an ordered series object

### 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 @@ -33,7 +33,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
Loading