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.

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

Document the context properties for ticks #7399

Open
wants to merge 4 commits into
base: master
from

Conversation

@kurkle
Copy link
Collaborator

kurkle commented May 22, 2020

Closes: #7337

@benmccann
Copy link
Collaborator

benmccann commented May 22, 2020

If you say "closes #7337" in the PR description then it will automatically get closed when this gets merged

docs/docs/general/options.md Outdated Show resolved Hide resolved
@etimberg etimberg linked an issue that may be closed by this pull request May 22, 2020
2 of 3 tasks complete
@kurkle kurkle force-pushed the kurkle:docs-context branch from 1112d7d to abedc9f May 28, 2020
@kurkle kurkle requested review from benmccann and etimberg May 31, 2020

## Indexable Options

Indexable options also accept an array in which each item corresponds to the element at the same index. Note that this method requires to provide as many items as data, so, in most cases, using a [function](#scriptable-options) is more appropriated if supported.

This comment has been minimized.

Copy link
@etimberg

etimberg May 31, 2020

Member

Needs a slight update for the looping behaviour that just got added

This comment has been minimized.

Copy link
@kurkle

kurkle Jun 4, 2020

Author Collaborator

Updated slightly, does that make sense?

@kurkle kurkle force-pushed the kurkle:docs-context branch from abedc9f to 12fdad7 Jun 4, 2020

## Indexable Options

Indexable options also accept an array in which each item corresponds to the element at the same index. Note that if there are less items than data, the items are looped over. In many cases, using a [function](#scriptable-options) is more appropriated if supported.

This comment has been minimized.

Copy link
@benmccann

benmccann Jun 4, 2020

Collaborator

appropriated -> appropriate

@@ -20,7 +20,7 @@ color: function(context) {

## Indexable Options

Indexable options also accept an array in which each item corresponds to the element at the same index. Note that this method requires to provide as many items as data, so, in most cases, using a [function](#scriptable-options) is more appropriated if supported.
Indexable options also accept an array in which each item corresponds to the element at the same index. Note that if there are less items than data, the items are looped over. In many cases, using a [function](#scriptable-options) is more appropriated if supported.

This comment has been minimized.

Copy link
@benmccann

benmccann Jun 4, 2020

Collaborator

appropriated -> appropriate

@@ -55,3 +46,68 @@ The majorTick configuration is nested under the ticks configuration in the `majo
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| `enabled` | `boolean` | `false` | If true, major ticks are generated. A major tick will affect autoskipping and `major` will be defined on ticks in the scriptable options context.

## Indexable Options

This comment has been minimized.

Copy link
@benmccann

benmccann Jun 4, 2020

Collaborator

Maybe we should just refer to general/options.md here instead of duplicating this part?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked issues

Successfully merging this pull request may close these issues.

3 participants
You can’t perform that action at this time.