Skip to content

Commit

Permalink
docs: add tonal linting
Browse files Browse the repository at this point in the history
  • Loading branch information
darthtrevino committed Nov 22, 2019
1 parent f7ccc6f commit edce961
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions .alexignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CHANGELOG.md
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"lint:js": "eslint . --ext .js,.ts,.jsx,.tsx",
"lint:md": "markdownlint 'packages/docs/docsite/content/markdown/**/*.md'",
"lint:spelling": "mdspell 'packages/docs/docsite/content/markdown/**/*.md' --en-us --report",
"lint:tone": "find . -name '*.md' | grep -v node_modules | yarn alex",
"lint:tone": "alex .",
"lint": "run-s lint:*",
"unit_test": "jest --coverage --ci",
"test": "run-s lint build unit_test test:packages",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ coupled to any platform.

## Key Concepts

<!--alex disable color -->

In _The Grammar of Graphics_, the author envisions a sequenced pipeline of
steps that are common to creating charts: including data transformations, scale
applications, mark binding, and rendering of marks and guides. Each of these
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ order: 1

## Introduction

<!--alex disable special color hook dive -->

So you're interested in using **chart-parts** for your application? Great
choice! If you're unfamiliar with the concept of the _Grammar of Graphics_
or _Mark-Based Visualization_, take a look at the
Expand All @@ -17,7 +19,7 @@ right in if you're up for it.
To use **chart-parts**, you must be using webapp environment with a bundler
present. If you're using [create-react-app](https://create-react-app.dev/),
or [webpack](https://webpack.js.org) directly you should be fine. To install
the requisite client libraries, execute the following command in your terminal.
the requisite client libraries, invoke the following command in your terminal.
I'm using [yarn](https://yarnpkg.com), but feel free to use _npm_ if you
prefer.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ path: /documentation/concepts
order: 3
---

<!--alex disable color -->

## Key Concepts

In this section we will describe, at overview-level, the key concepts that are
Expand All @@ -21,7 +23,7 @@ coordinates, colors, etc...
In chart-parts, our scales are based on d3 scales, and assume basic familiarity
with how they operate.

Here are some resources regarding d3 scales that may he helpful:
Here are some resources regarding d3 scales that may be helpful:

- [d3-scale GitHub repository](https://github.com/d3/d3-scale)
- [d3-scale-chromatic GitHub repository](https://github.com/d3/d3-scale-chromatic)
Expand Down
2 changes: 1 addition & 1 deletion packages/processing/vsvg/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Purpose

This package converts chart-parts scenegraphs into virtual-svg documents, these are basically a Virtual-Dom for SVGs, but abstract enough to be used by different SVG implementations.
This package converts chart-parts scenegraphs into virtual-svg documents, these are essentially a Virtual-Dom for SVGs, but abstract enough to be used by different SVG implementations.
2 changes: 1 addition & 1 deletion packages/util/scales/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Purpose

This library contains the builder-based API for creating named scales in chart-parts. These all basically thunk over to d3.
This library contains the builder-based API for creating named scales in chart-parts. These all essentially thunk over to d3.

0 comments on commit edce961

Please sign in to comment.