From 20e9918d93841ca086bde8db876ef6d19558d688 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Tue, 7 Jul 2020 04:14:34 +1000 Subject: [PATCH] Fix spelling and lint Markdown. Remove whitespace. Fixed bare URLS. Remove unneeded blank lines. Add blank lines. Indent HTML. --- BUILDING.md | 4 ++-- CHANGELOG.md | 24 ++++++++++++------------ CONTRIBUTING.md | 8 ++++---- README.md | 14 +++++++------- 4 files changed, 25 insertions(+), 25 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index f364c6005e3..5e0a06efcc0 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -35,7 +35,6 @@ var Plotly = require('plotly.js'); then simply run, - ``` browserify index.js > bundle.js ``` @@ -92,10 +91,11 @@ module.exports = { "path": "./extra-webpack.config.js", "replaceDuplicatePlugins": true, "mergeStrategies": {"module.rules": "merge"} - } + } } } ... ``` + It's important to set `projects.x.architect.build.builder` and `projects.x.architect.build.options.customWebpackConfig`. If you have more projects in your `angular.json` make sure to adjust their settings accordingly. diff --git a/CHANGELOG.md b/CHANGELOG.md index e86734bc7d2..ce4c6c2c53a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ For more context information, please read through the To see all merged commits on the master branch that will be part of the next plotly.js release, go to: -https://github.com/plotly/plotly.js/compare/vX.Y.Z...master + where X.Y.Z is the semver of most recent plotly.js release. @@ -249,7 +249,7 @@ where X.Y.Z is the semver of most recent plotly.js release. ## [1.51.1] -- 2019-11-04 ### Fixed -- Fix `scattergl` mising points plot and react (bug introduced in 1.33.0) [#4323] +- Fix `scattergl` missing points plot and react (bug introduced in 1.33.0) [#4323] - Skip non-numeric values in `image` trace plot [#4325] @@ -989,7 +989,7 @@ First 2019 release. - Improve `splom` first-render, axis range relayout and marker restyle performance [#3057, #3161] - Make `splom` `xaxes` and `yaxes` list always have same length as the trace - `dimensions` regardless of their partial visiblities [#3057] + `dimensions` regardless of their partial visibilities [#3057] - Improve axis `overlaying` documentation [#3082] ### Fixed @@ -1325,7 +1325,7 @@ First 2019 release. - Fix "sloppy click" event emission during cartesian zoom [#2649] - Fix layout `grid` validation which lead to exceptions [#2638] - Fix `parcoords` rendering in old Safari version [#2612] -- Link to https://get.webgl.org instead of http version in no WebGL message [#2617] +- Link to instead of http version in no WebGL message [#2617] ## [1.37.1] -- 2018-05-02 @@ -1563,9 +1563,9 @@ First 2019 release. - Fix `gl2d` tick label on pan interaction regression [#2258] - Fix `candlestick` hover label regression (bug introduced in v1.32.0) [#2264] - Fix several `gl2d` axis related bugs with new regl-based `scattergl` [#2258] - See full list under the On-par gl2d milestone https://github.com/plotly/plotly.js/milestone/3 + See full list under the On-par gl2d milestone - Fix several polar bugs with `scatterpolar` [#2200]. - See full list under the On-par polar milestone https://github.com/plotly/plotly.js/milestone/2 + See full list under the On-par polar milestone - Fix `scattergl` marker.colorscale handling [#2258] - Fix ternary relayout calls involving axis tick styles and titles [#2200] - Fix decimal and thousands settings in `de` locale [#2246] @@ -1945,7 +1945,7 @@ First 2019 release. ### Fixed - rm `const` token from dist bundles that depend on `big-rat`, - see https://github.com/rat-nest/big-rat/pull/4 for more details. + see for more details. ## [1.25.1] -- 2017-03-28 @@ -2174,7 +2174,7 @@ First 2019 release. - Fix 1.20.0 regression in handling numerical strings including commas and spaces [#1185] - Fix 1.20.0 regression involving date histograms [#1186] -- Fix numerous tickvals` and `ticktext` edge cases [#1191] +- Fix numerous `tickvals` and `ticktext` edge cases [#1191] ## [1.20.4] -- 2016-11-21 @@ -2495,7 +2495,7 @@ First 2019 release. - Fix mapbox layer relayout starting from invisible layer [#693] - Hover labels when `hoveron: 'fills'` are now constrained to the viewports [#688] -- Fix `surface` countours description [#696] +- Fix `surface` contours description [#696] - Fix `mapbox.layers.line` description [#690] @@ -2741,8 +2741,8 @@ First 2019 release. ## [1.6.3] -- 2016-03-07 ### Fixed -- Argument parsing for vertex and face colors of mesh3d traces is now - functional [#287] +- Argument parsing for vertex and face colors of mesh3d traces is now + functional [#287] ## [1.6.2] -- 2016-03-03 @@ -2889,7 +2889,7 @@ First 2019 release. - Improve XSS check in anchor href [#100] ### Fixed -- Fix Fifefox 42 to-image failures [#104] +- Fix Firefox 42 to-image failures [#104] - Fix error bar with type 'sqrt' logic making them visible without specifying the 'value' field [#91] - Fix cartesian zoom/drag cover attributes for Firefox 31 [#92] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aec1580e6a9..d558cf23f20 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,7 +75,6 @@ test dashboard, inspect and debug the changes, then repeat. The test dashboard comes bundled with some useful tools while developing - all bundled under the `Tabs` object: - | Method/Property | Description | |------------------------|-------------| | `Tabs.fresh([id])` | Creates a fresh graph div and returns it (default id of `graph`). | @@ -101,8 +100,8 @@ image mocks based on their file name and trace type. Use the [`plotly-mock-viewer`](https://github.com/rreusser/plotly-mock-viewer) which has live-reloading and a bunch of other cool features. -An online version of `plotly-mock-viewer` is available at https://rreusser.github.io/plotly-mock-viewer/ -which uses https://cdn.plot.ly/plotly-latest.min.js +An online version of `plotly-mock-viewer` is available at +which uses #### Other npm scripts @@ -179,6 +178,7 @@ To view the image pixel comparison test results, run ``` npm run start-image_viewer ``` + which shows the baseline image, the generated image, the diff and the json mocks of test cases that failed. To view the results of a run on CircleCI, download the `build/test_images/` and `build/test_images_diff/` artifacts into your local repo and then run `npm run start-image_viewer`. @@ -196,7 +196,7 @@ To view the results of a run on CircleCI, download the `build/test_images/` and ### Writing jasmine interaction tests -Keep in mind that the interaction coordinates are relative to the top-left corner of the plot, including the margins. To produce a reliable interaction test, +Keep in mind that the interaction coordinates are relative to the top-left corner of the plot, including the margins. To produce a reliable interaction test, it may be necessary to fix the width, height, margins, X axis range and Y axis range of the plot. For example: ```js diff --git a/README.md b/README.md index 8c8012d49c7..61a2969b535 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,9 @@ and more.

- -

+ + +

[Contact us](https://plotly.com/products/consulting-and-oem/) for Plotly.js consulting, dashboard development, application integration, and feature additions. @@ -29,7 +30,6 @@ and more. * [Creators](#creators) * [Copyright and license](#copyright-and-license) - ## Quick start options ### Install with npm @@ -38,7 +38,8 @@ and more. npm install plotly.js-dist ``` -and import plotly.js as +and import plotly.js as + ```js import Plotly from 'plotly.js-dist' // Or using require, @@ -60,7 +61,7 @@ var Plotly = require('plotly.js-dist') and use the `Plotly` object in the window scope. -Fastly supports Plotly.js with free CDN service. Read more at https://www.fastly.com/open-source +Fastly supports Plotly.js with free CDN service. Read more at ### Download the latest release @@ -70,7 +71,6 @@ and use the plotly.js `dist` file(s). More info [here](https://github.com/plotly #### Read the [Getting started page](https://plotly.com/javascript/getting-started/) for more examples. - ## Modules Starting in `v1.15.0`, plotly.js ships with several _partial_ bundles (more info [here](https://github.com/plotly/plotly.js/blob/master/dist/README.md#partial-bundles)). @@ -149,6 +149,7 @@ Open-source clients to the plotly.js APIs are available at these links: |**Python / Pandas / IPython notebook**| [plotly/plotly.py](https://github.com/plotly/plotly.py) | [plotly/python/getting-started](https://plotly.com/python/getting-started) | |**MATLAB**| [plotly/matlab-api](https://github.com/plotly/matlab-api) | [plotly/matlab/getting-started](https://plotly.com/matlab/getting-started) | |**node.js / Tonicdev / Jupyter notebook**| [plotly/plotly-notebook-js](https://github.com/plotly/plotly-notebook-js) | | + ## Creators ### Active @@ -176,7 +177,6 @@ Open-source clients to the plotly.js APIs are available at these links: |**Chris Parmer**| [@chriddyp](https://github.com/chriddyp) | | |**Alex Vados**| [@alexander-daniel](https://github.com/alexander-daniel) | | - ## Copyright and license Code and documentation copyright 2020 Plotly, Inc.