Merge pull request #7733 from NssGourav/docs/fix-typos-and-grammar

docs: fix minor typos, grammar, and formatting

Author: camdecoster

BUILDING.md

@@ -6,7 +6,7 @@ The sections below provide additional info in respect to alternative building fr
 ---
 ## Angular CLI
 
-Since Angular uses webpack under the hood and doesn't allow easily to change it's webpack configuration, there is some work needed using a `custom-webpack` builder to get things going.
+Since Angular uses webpack under the hood and doesn't easily allow changing its webpack configuration, there is some work needed using a `custom-webpack` builder to get things going.
 
 1. Install [`@angular-builders/custom-webpack`](https://www.npmjs.com/package/@angular-builders/custom-webpack) and [ify-loader@v1.1.0+](https://github.com/hughsk/ify-loader)
 2. Create a new `extra-webpack.config.js` beside `angular.json`.
@@ -28,7 +28,7 @@ module.exports = {
 };
 ```
 
-3. Change the builder in `angular.json` to `"@angular-builders/custom-webpack:browser` and configure it correctly to use our new webpack config.
+3. Change the builder in `angular.json` to `"@angular-builders/custom-webpack:browser"` and configure it correctly to use our new webpack config.
 
 > angular.json
 ```json

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 # Contributing to Plotly.js
 
 Thanks for your interest in contributing to Plotly.js! We are actively looking for
-diverse contributors, with diverse background and skills.
+diverse contributors, with diverse backgrounds and skills.
 
 This document outlines the general way that changes get made to this library and by whom,
 and then provides specific technical information about how to set up a development
@@ -79,12 +79,12 @@ We use the following [labels](https://github.com/plotly/plotly.js/labels) to tra
 - git
 - [node.js](https://nodejs.org/en/). We recommend using node.js v18.x.
   Upgrading and managing node versions can be easily done using
-  [`nvm`](https://github.com/creationix/nvm) or its Windows alternatives.
+  [`nvm`](https://github.com/nvm-sh/nvm) or its Windows alternatives.
 - [`npm`](https://www.npmjs.com/) v10.x and up to ensure that the
   [`package-lock.json`](https://docs.npmjs.com/files/package-lock.json) file is
   used and updated correctly.
 - [`python3`](https://www.python.org/downloads/)
-Note: for M1 mac users specifically, you might need to install some [extra dependencies](https://github.com/Automattic/node-canvas/issues/1733#issuecomment-761703018). 
+Note: For M1 Mac users specifically, you might need to install some [extra dependencies](https://github.com/Automattic/node-canvas/issues/1733#issuecomment-761703018). 
 
 #### Step 1: Fork the plotly.js repository, clone your fork and step into it
 
@@ -332,7 +332,7 @@ This will produce the following plot, and say you want to simulate a selection p
 - Sources files are in `src/`
 - Build and repo management scripts are in `tasks/`
 - All tasks can be run using [`npm run-script`](https://docs.npmjs.com/cli/run-script)
-- Tests are `test/`, they are partitioned into `image` and `jasmine` tests
+- Tests are in `test/`; they are partitioned into `image` and `jasmine` tests
 - Test dashboard and image viewer code is in `devtools/`
 - Built files are in `build/` (the files in here are git-ignored, except for `plotcss.js`)
 
@@ -384,10 +384,10 @@ Other methods used by some trace modules:
   selections.
 - `_module.convert`: Sometimes separated from `_module.plot` or `_module.calc` to convert the
   plotly.js settings to another framework e.g. to `gl-plot3d` for `gl3d` traces, to
-  `mapbox-gl` from `mapbox` traces. This split can make the logic easier to test.
+  `mapbox-gl` for `mapbox` traces. This split can make the logic easier to test.
   If you make a `convert`, you should call it from either `calc` or `plot`.
 
 ## Coding style
 
-Check if ok, with `npm run lint`
+Check if OK with `npm run lint`
 

CUSTOM_BUNDLE.md

@@ -1,5 +1,5 @@
 # Custom bundle
-You can simply make custom bundles yourself, if none of the [distributed packages](https://github.com/plotly/plotly.js/blob/master/dist/README.md) meet your needs, or you want to make a more optimized bundle file with/without specific traces.
+You can easily make custom bundles yourself if none of the [distributed packages](https://github.com/plotly/plotly.js/blob/master/dist/README.md) meet your needs, or if you want to make a more optimized bundle file with/without specific traces.
 
 Make sure you have the versions of node/npm that's recommended:
 - plotly.js before 2.5: Node 12/npm 6
@@ -15,19 +15,19 @@ Clone plotly.js, where the <version> is one of [these](https://github.com/plotly
 git clone --branch <version> https://github.com/plotly/plotly.js.git
 ```
 
-Note: If you've already cloned plotly.js, then could switch to another version with:
+Note: If you've already cloned plotly.js, then you can switch to another version with:
 ```sh
 git fetch
 git checkout <version>
 ```
 
-Move to plotly.js folder then install plotly.js dependencies:
+Move to the `plotly.js` directory, then install its dependencies:
 ```sh
 cd plotly.js
 npm i
 ```
 
-By default all traces are included in the bundle if you simply run:
+By default, all traces are included in the bundle if you simply run:
 ```sh
 npm run custom-bundle
 ```
@@ -56,7 +56,7 @@ npm run custom-bundle -- --unminified
 ```
 
 # Example illustrating use of different options together
-To create an unminified custom bundle named `myScatters` including `scatter`, `scattergl` and `scatter3d` traces:
+To create an unminified custom bundle named `myScatters` including `scatter`, `scattergl`, and `scatter3d` traces:
 ```sh
 npm run custom-bundle -- \
     --unminified \

README.md

@@ -4,7 +4,7 @@
 [![circle ci](https://circleci.com/gh/plotly/plotly.js.svg?style=shield)](https://circleci.com/gh/plotly/plotly.js)
 [![MIT License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://github.com/plotly/plotly.js/blob/master/LICENSE)
 
-[Plotly.js](https://plotly.com/javascript) is a standalone Javascript data visualization library, and it also powers the Python and R modules named `plotly` in those respective ecosystems (referred to as [Plotly.py](https://plotly.com/python) and [Plotly.R](http://plotly.com/r)).
+[Plotly.js](https://plotly.com/javascript) is a standalone JavaScript data visualization library, and it also powers the Python and R modules named `plotly` in those respective ecosystems (referred to as [Plotly.py](https://plotly.com/python) and [Plotly.R](http://plotly.com/r)).
 
 Plotly.js can be used to produce dozens of chart types and visualizations, including statistical charts, 3D graphs, scientific charts, SVG and tile maps, financial charts and more.
 
@@ -58,7 +58,7 @@ You may also consider using [`plotly.js-dist`](https://www.npmjs.com/package/plo
 ## Load via script tag
 
 ### The script HTML element
-> In the examples below `Plotly` object is added to the window scope by `script`. The `newPlot` method is then used to draw an interactive figure as described by `data` and `layout` into the desired `div` here named `gd`. As demonstrated in the example above basic knowledge of `html` and [JSON](https://en.wikipedia.org/wiki/JSON) syntax is enough to get started i.e. with/without JavaScript! To learn and build more with plotly.js please visit [plotly.js documentation](https://plotly.com/javascript).
+> In the examples below, the `Plotly` object is added to the window scope by the `script` tag. The `newPlot` method is then used to draw an interactive figure as described by `data` and `layout` into the desired `div` here named `gd`. As demonstrated in the example above, basic knowledge of HTML and [JSON](https://en.wikipedia.org/wiki/JSON) syntax is enough to get started, i.e., with or without JavaScript! To learn and build more with plotly.js, please visit the [plotly.js documentation](https://plotly.com/javascript).
 
 ```html
 <head>
@@ -76,7 +76,7 @@ You may also consider using [`plotly.js-dist`](https://www.npmjs.com/package/plo
 </body>
 ```
 
-Alternatively you may consider using [native ES6 import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) in the script tag.
+Alternatively, you may consider using [native ES6 import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) in the script tag.
 ```html
 <script type="module">
     import "https://cdn.plot.ly/plotly-3.4.0.min.js"
@@ -95,7 +95,7 @@ While non-minified source files may contain characters outside UTF-8, it is reco
 > Please note that as of v2 the "plotly-latest" outputs (e.g. https://cdn.plot.ly/plotly-latest.min.js) will no longer be updated on the CDN, and will stay at the last v1 patch v1.58.5. Therefore, to use the CDN with plotly.js v2 and higher, you must specify an exact plotly.js version.
 
 ### MathJax
-You could load either version two or version three of MathJax files, for example:
+You can load either version two or version three of MathJax files. For example:
 ```html
 <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_SVG.js"></script>
 ```
@@ -108,15 +108,15 @@ You could load either version two or version three of MathJax files, for example
 Please refer to `devtools/test_dashboard/index-mathjax3chtml.html` to see an example.
 
 ### Need to have several WebGL graphs on a page?
-You may simply load [virtual-webgl](https://github.com/greggman/virtual-webgl) script for WebGL 1 (not WebGL 2) before loading other scripts.
+You may simply load the [virtual-webgl](https://github.com/greggman/virtual-webgl) script for WebGL 1 (not WebGL 2) before loading other scripts.
 ```html
 <script src="https://unpkg.com/virtual-webgl@1.0.6/src/virtual-webgl.js"></script>
 ```
 
 ## Bundles
 There are two kinds of plotly.js bundles:
 1. Complete and partial official bundles that are distributed to `npm` and the `CDN`, described in [the dist README](https://github.com/plotly/plotly.js/blob/master/dist/README.md).
-2. Custom bundles you can create yourself to optimize the size of bundle depending on your needs. Please visit [CUSTOM_BUNDLE](https://github.com/plotly/plotly.js/blob/master/CUSTOM_BUNDLE.md) for more information.
+2. Custom bundles you can create yourself to optimize the size of the bundle depending on your needs. Please visit [CUSTOM_BUNDLE](https://github.com/plotly/plotly.js/blob/master/CUSTOM_BUNDLE.md) for more information.
 
 ---
 ## Alternative ways to load and build plotly.js
@@ -133,7 +133,7 @@ For more info about contributing to Plotly documentation, please read through [c
 ---
 ## Bugs and feature requests
 
-Have a bug or a feature request? Please [open a Github issue](https://github.com/plotly/plotly.js/issues/new) keeping in mind the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/.github/ISSUE_TEMPLATE.md). You may also want to read about [how changes get made to Plotly.js](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md)
+Have a bug or a feature request? Please [open a Github issue](https://github.com/plotly/plotly.js/issues/new) keeping in mind the [issue guidelines](https://github.com/plotly/plotly.js/blob/master/.github/ISSUE_TEMPLATE.md). You may also want to read about [how changes get made to Plotly.js](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md).
 
 ---
 ## Contributing

SECURITY.md

@@ -6,7 +6,7 @@ The open source plotly.js library is provided "AS IS", with no security guarante
 In the 1.x releases of plotly.js, we attempt to protect against XSS attacks (and similar issues) resulting from
 untrusted data being graphed by plotly.js.  However, XSS or other issues may still exist.
 
-Note that the typical use case for plotly.js is for visualizing data from trusted sources.  For example if you use plotly.js to add a dashboard to your site and you control all the input data that's sent to plotly.js, you are not dependent on plotly.js for XSS protection.
+Note that the typical use case for plotly.js is for visualizing data from trusted sources.  For example, if you use plotly.js to add a dashboard to your site and you control all the input data that's sent to plotly.js, you are not dependent on plotly.js for XSS protection.
 
 If you require a higher degree of assurance, please consider purchasing our
 [Plotly On-Premise](https://plotly.com/get-pricing/) product, or [contact the Plotly sales team](mailto:sales@plotly.com)
@@ -23,7 +23,7 @@ In some cases, we offer monetary compensation (bounties) for reports of security
 
 ## Release Process
 
-plotly.js security fixes are normally released as "patch" releases on top of the current plotly.js version.  For example if the current plotly.js version is 1.14.0 and we fix a security issue, we will release 1.14.1 with the fix.  Alternatively, security fixes may be made as part of a major or minor plotly.js release, if the fix coincides with our normal release cycle.  For example if the current plotly.js version is 1.14.0, we may release version 1.15.0 with the fix instead of 1.14.1.
+plotly.js security fixes are normally released as "patch" releases on top of the current plotly.js version.  For example, if the current plotly.js version is 1.14.0 and we fix a security issue, we will release 1.14.1 with the fix.  Alternatively, security fixes may be made as part of a major or minor plotly.js release, if the fix coincides with our normal release cycle.  For example, if the current plotly.js version is 1.14.0, we may release version 1.15.0 with the fix instead of 1.14.1.
 
 Security fixes are backported to older versions of plotly.js as required by paying Plotly On-Premise or Plotly Cloud customers.  These fixes are released as "patch" releases, and are made available to the community once affected customers have upgraded.  We also accept backports to older versions contributed by community members.
 

test/plot-schema.json

@@ -124,6 +124,11 @@
         false
       ]
     },
+    "displayNotifier": {
+      "description": "Determines whether or not notifier is displayed.",
+      "dflt": true,
+      "valType": "boolean"
+    },
     "doubleClick": {
       "description": "Sets the double click interaction mode. Has an effect only in cartesian plots. If *false*, double click is disable. If *reset*, double click resets the axis ranges to their initial values. If *autosize*, double click set the axis ranges to their autorange values. If *reset+autosize*, the odd double clicks resets the axis ranges to their initial values and even double clicks set the axis ranges to their autorange values.",
       "dflt": "reset+autosize",