Spelling fixes

finos · Jan 6, 2021 · 11f39bd · 11f39bd
1 parent 2415be2
commit 11f39bd
Show file tree

Hide file tree

Showing 9 changed files with 145 additions and 146 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ data or streaming updates via [Apache Arrow](https://arrow.apache.org/).
 
 - A fast, memory efficient streaming query engine, written in C++ and compiled to [WebAssembly](https://webassembly.org/), with read/write/stream support for [Apache Arrow](https://arrow.apache.org/).
 
-- A framework-agnostic query configuration UI component, based on [Web Components](https://www.webcomponents.org/), and a WebWorker and/or WebSocket data engine host for stable interactivity at high frequency.
+- A framework-agnostic query configuration UI component, based on [Web Components](https://www.webcomponents.org/), and a Web Worker and/or WebSocket data engine host for stable interactivity at high frequency.
 
 - A customizable HTML Data Grid plugin, and a Chart plugin built on [D3FC](https://d3fc.io/).
 
@@ -45,7 +45,7 @@ data or streaming updates via [Apache Arrow](https://arrow.apache.org/).
 
 * [Project Site](https://perspective.finos.org/)
 * [Installation](https://perspective.finos.org/docs/md/installation.html)
-* [Javascript User's Guide](https://perspective.finos.org/docs/md/js.html)
+* [JavaScript User's Guide](https://perspective.finos.org/docs/md/js.html)
 * [Python User's Guide](https://perspective.finos.org/docs/md/python.html)
 * [Developer's Guide](https://perspective.finos.org/docs/md/development.html)
 * [Conceptual Overview](https://perspective.finos.org/docs/md/concepts.html)

diff --git a/docs/README.md b/docs/README.md
@@ -1,11 +1,10 @@
 # Perspective Documentation Site
 
-This is the source for the [Perspective documentaiton github-pages site](https://perspective.finos.org/) - 
-what you're looking for is probably there.  Links to the source documenation
+This is the source for the [Perspective documentation GitHub Pages site](https://perspective.finos.org/); what you're looking for is probably there. Links to the source documentation
 from which the site is rendered:
 
 * [Installation](https://github.com/finos/perspective/blob/master/docs/md/installation.md)
 * [User's Guide](https://github.com/finos/perspective/blob/master/docs/md/usage.md)
 * [Developer's Guide](https://github.com/finos/perspective/blob/master/docs/md/development.md)
 * [Perspective API](https://github.com/finos/perspective/blob/master/packages/perspective/README.md)
-* [Perspective Viewer API](https://github.com/finos/perspective/blob/master/packages/perspective-viewer/README.md)
+* [Perspective Viewer API](https://github.com/finos/perspective/blob/master/packages/perspective-viewer/README.md)
diff --git a/docs/core/Footer.js b/docs/core/Footer.js
@@ -29,7 +29,7 @@ class Footer extends React.Component {
                     <div>
                         <h5>Docs</h5>
                         <a href={"/docs/md/installation.html"}>Installation</a>
-                        <a href={"/docs/md/js.html"}>Javascript User Guide</a>
+                        <a href={"/docs/md/js.html"}>JavaScript User Guide</a>
                         <a href={"/docs/md/python.html"}>Python User Guide</a>
                         <a href={"/docs/obj/perspective.html"}>Perspective API</a>
                         <a href={"/docs/obj/perspective-viewer.html"}>Perspective Viewer API</a>

diff --git a/docs/md/concepts.md b/docs/md/concepts.md
@@ -29,8 +29,8 @@ a `View`:
 For language-specific guidance, API documentation, or quick-start user guides,
 use the sidebar to find the documentation for the language of choice. Though
 the way these concepts operate in practice may vary slightly across different
-languages based on nuance, the concepts documented here hold true across all
-implementations of the Perspective library.
+languages, the concepts documented here hold true across all implementations of
+the Perspective library.
 
 <!--truncate-->
 
@@ -108,7 +108,7 @@ A `Table` can be initialized in two ways:
   empty.
 - With a dataset in a supported format;  in this case, a `schema` is inferred
   from the dataset's structure upon initialization.  Perspective supports a
-  variety of table-like data structures in Python and Javascript such as CSV,
+  variety of table-like data structures in Python and JavaScript such as CSV,
   `pandas.DataFrame` and JSON; see the language specific API documentation for
   a comprehensive list of supported formats.
 
@@ -151,7 +151,7 @@ some column values `undefined`, and _removes_ to delete a row by `index`.
 
 Once a `Table` has been created, it can be updated with new data conforming to
 the `Table`'s `schema`. The dataset used for `update()` must conform with the
-formats supported by Perspective, and cannot be a `schema` (as the `schema`
+formats supported by Perspective and cannot be a `schema` (as the `schema`
 is immutable).
 
 If a `Table` was initialized with a `schema` instead of a dataset, use `update`
@@ -217,10 +217,10 @@ with an array of primary key values indicating which rows should be removed.
 
 Due to Perspective's runtime composition, it is important to clean up resources
 that might have been created by the engine in C++ but cannot be reached by the
-binding language's garbage collector (Javascript, Python etc.)
+binding language's garbage collector (JavaScript, Python etc.)
 
 The `Table`'s `delete` method guarantees the cleanup of all resources associated
-with a `Table`, which is _especially important_ in Javascript, as the JS garbage
+with a `Table`, which is _especially important_ in JavaScript, as the JS garbage
 collector [cannot automatically clean up](https://emscripten.org/docs/porting/connecting_cpp_and_javascript/embind.html#memory-management)
 objects created in C++ through Emscripten.
 
@@ -266,7 +266,7 @@ view.delete();
 ```
 
 `View` objects are immutable with respect to the arguments provided to the
-`view()` method;  to change these parameters, you must create a new `View` on
+`view()` method. To change these parameters, you must create a new `View` on
 the same `Table`. However, `View`s are live with respect to the `Table`'s data,
 and will (within a conflation window) update with the latest state as its
 parent's state updates, including incrementally recalculating all aggregates,
@@ -323,13 +323,13 @@ what you see.
 ### Row Pivots
 
 A row pivot _groups_ the dataset by the unique values of each column used as a
-row pivot - a close analogue in SQL would be the `GROUP BY` statement.
+row pivot. A close analogue to this would be the `GROUP BY` statement in SQL.
 
 The underlying dataset is aggregated to show the values belonging to
 each group, and a total row is calculated for each group, showing the currently
 selected aggregated value (e.g. `sum`) of the column. Row pivots are useful for
 hierarchies, categorizing data and attributing values, i.e. showing the number
-of units sold based on State and City.
+of units sold based on state and city.
 
 In Perspective, row pivots are represented as an array of string column names
 which will be applied as row pivots:
@@ -392,7 +392,7 @@ column pivots are also easily transposable in `perspective-viewer`.
 ### Aggregates
 
 Aggregates perform a calculation over an entire column, and are displayed when
-one or more [Row Pivots](#row-pivots) are applied to the `View`. Aggregates can
+one or more [row pivots](#row-pivots) are applied to the `View`. Aggregates can
 be specified by the user, or Perspective will use the following sensible default
 aggregates based on column type:
 
@@ -401,7 +401,7 @@ aggregates based on column type:
 
 Perspective provides a large selection of aggregate functions that can be
 applied to columns in the `View` constructor using a dictionary of column
-name to aggregate function name:
+names to aggregate function names:
 
 ```javascript
 const view = table.view({

diff --git a/docs/md/development.md b/docs/md/development.md
@@ -7,20 +7,20 @@ Thank you for your interest in contributing to Perspective! This guide will
 teach you everything you need to know to get started hacking on the Perspective
 codebase.
 
-If you're coming to this project as principally a Javascript developer, please
+If you're coming to this project as principally a JavaScript developer, please
 be aware that Perspective is quite a bit more complex than a typical NPM package
 due to the mixed-language nature of the project; we've done quite a bit to make
 sure the newcomer experience is as straightforward as possible, but some things
 might not work the way you're used to!
 
 Perspective is organized as a
-[monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md),
+[monorepo](https://github.com/babel/babel/blob/master/doc/design/monorepo.md)
 and uses [lerna](https://lernajs.io/) to manage dependencies. The
 `@finos/perspective` modules has an additional, unmanaged dependency—the
 [Emscripten](https://github.com/kripken/emscripten) compiler, which is used to
 compile the core C++ engine to WebAssembly, and must be installed independently.
 
-This guide provides instructions for both the Javascript and Python libraries.
+This guide provides instructions for both the JavaScript and Python libraries.
 To switch your development toolchain between the two, use `yarn setup`. Once the
 setup script has been run, common commands like `yarn build` and `yarn test`
 automatically call the correct build and test tools.
@@ -56,7 +56,7 @@ To build Perspective using Docker, select the option in `yarn setup`.
 
 ## `Perspective.js`
 
-To build the Javascript library, which includes WebAssembly compilation,
+To build the JavaScript library, which includes WebAssembly compilation,
 [Emscripten](https://github.com/kripken/emscripten) and its prerequisites are
 required. A Docker image is provided with the correct environment and
 prerequisites.
@@ -111,8 +111,8 @@ yarn build_python --python2
 `perspective-python` requires the following system dependencies to be installed before it can be
 built from source:
 
-- Boost (version 1.67)
-- CMake (version 3.15.4 or higher)
+- [Boost](https://www.boost.org/) (version 1.67)
+- [CMake](https://cmake.org/) (version 3.15.4 or higher)
 - TBB
 
 ## System-Specific Instructions
@@ -140,8 +140,8 @@ Installing and activating the latest
 
 #### `perspective-python`
 
-If building the Python 2 version of the library, make sure your version of
-Python 2 is the latest version (`2.7.17`) supplied by Homebrew, and not the
+If you're building the Python 2 version of the library, make sure your version
+of Python 2 is the latest version (`2.7.17`) supplied by Homebrew, and not the
 earlier version that ships with MacOS. To install Python 2 using Homebrew:
 
 ```bash
@@ -153,10 +153,10 @@ brew install python2
 You need to use bash in order to build Perspective packages. To successfully
 build on Windows 10, enable
 [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
-(WSL) and install the linux distribution of your choice.
+(WSL) and install the Linux distribution of your choice.
 
 Create symbolic links to easily access Windows directories and projects modified
-via Windows. This way you can modify any of the Perspective files using your
+via Windows. This way, you can modify any of the Perspective files using your
 favorite editors on Windows and build via Linux.
 
 Follow the Linux specific instructions to install Emscripten and all
@@ -167,10 +167,10 @@ prerequisite tools.
 When installing Emscripten, make sure to follow
 [Linux specific instructions](http://kripken.github.io/emscripten-site/docs/getting_started/downloads.html#linux).
 
-On Ubuntu, cmake will mistakenly resolve the system headers in `/usr/include`
+On Ubuntu, Cmake will mistakenly resolve the system headers in `/usr/include`
 rather than the emscripten supplied versions. You can resolve this by moving
 `boost` and `flatbuffers` dependencies to somewhere other than `/usr/include` -
-into perspective's own `src` dir, for example (as per
+into Perspective's own `src` dir (as per
 [here](http://vclf.blogspot.com/2014/08/emscripten-linking-to-boost-libraries.html)).
 
 ```bash
@@ -195,17 +195,17 @@ build the test suite for every package and run them.
 yarn test
 ```
 
-A Test name regex can be passed to `jest` via the same `-t` flag:
+A test name regex can be passed to `jest` via the same `-t` flag:
 
 ```bash
 yarn test -t 'button test (A|B)'
 ```
 
-### Javascript
+### JavaScript
 
-The Javascript test suite is composed of two sections: a Node.js test which
+The JavaScript test suite is composed of two sections: a Node.js test, which
 asserts behavior of the `@finos/perspective` library, and a suite of
-[Puppeteer](https://developers.google.com/web/tools/puppeteer/) tests which
+[Puppeteer](https://developers.google.com/web/tools/puppeteer/) tests, which
 assert the behavior of the rest of the UI facing packages. For the latter,
 you'll need Docker installed, as these tests use a Puppeteer and Chrome build
 installed in a Docker container.
@@ -228,22 +228,22 @@ flag:
 yarn test --write
 ```
 
-For quick local iteration and debugging failing tests, the puppeteer tests can
+For quick local iteration and debugging failing tests, the Puppeteer tests can
 use a local copy of Puppeteer, rather than relying on the supplied Docker image.
 These will run much quicker, and can be optionally run without `--headless` mode
 for debugging test failures quickly. However, due to rendering inconsistencies
 between platforms, the resulting test hashes will not match the ones saved in
 `results.json`, so you will need to re-run the suite with the `--write` flag to
 generate a `results.local.json` file specific to your OS.
 
-To toggle between Local and Docker Puppeteer, run
+To toggle between local and Docker Puppeteer, run
 
 ```bash
 yarn toggle_puppeteer
 ```
 
-This will install a local copy of puppeteer via `yarn` the first time it is run,
-if a local puppeteer is not found.
+This will install a local copy of Puppeteer via `yarn` the first time it is run,
+if a local Puppeteer is not found.
 
 ### Python
 
@@ -252,14 +252,14 @@ the Python library.
 
 If you have built the library with the `--python2` flag, make sure to run the
 test suite using the `--python2` flag as well. Running a version of
-perspective-python built against Python 2 in Python 3 (and vice versa) is not
+`perspective-python` built against Python 2 in Python 3 (and vice versa) is not
 supported.
 
 Verbosity in the tests can be enabled with the `--verbose` flag.
 
-#### Timezones in Python Tests
+#### Time zones in Python Tests
 
-Python tests are configured to use the `UTC` timezone. If running tests locally,
+Python tests are configured to use the `UTC` time zone. If running tests locally,
 you might find that datetime-related tests fail to assert the correct values. To
 correct this, run tests with the `TZ=UTC`, i.e.