Skip to content

Commit 57a4005

Browse files
committed
typos
1 parent 59838ee commit 57a4005

File tree

1 file changed

+12
-12
lines changed
  • plotly/tests/test_optional/test_jupyter

1 file changed

+12
-12
lines changed

Diff for: plotly/tests/test_optional/test_jupyter/README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Run the tests:
3333
- Save the resulting `.ipynb` file in `fixtures/` (e.g. `my_test.ipynb`)
3434

3535
- Add a JavaScript test file in `js_tests/` by first requiring the in-house
36-
[`tape`](https://github.com/substack/tape) test wrapper found in `lib/tape-wrapper.js`.
36+
[`tape`](https://github.com/substack/tape) test wrapper found in `lib/tape-wrapper.js`.
3737

3838
For example,
3939

@@ -48,13 +48,13 @@ test('should have one plotly.js graph', function(t) {
4848
});
4949
```
5050

51-
asserts that one plotly graph is present in the notebook.
51+
asserts that one plotly graph is present in the notebook.
5252

53-
At the moment, it is highly recommended that the js test file has the same name
53+
At the moment, it is highly recommended that the `js` test file has the same name
5454
(minus the extension) as the `.ipynb` fixture (i.e. `my_test.js` in this
5555
example).
5656

57-
- Add a test case in `test_jupyter.py`. If both the fixture and js test file
57+
- Add a test case in `test_jupyter.py`. If both the fixture and `js` test file
5858
have the same name, simply add:
5959

6060
```py
@@ -70,12 +70,12 @@ to `test_jupyter.py` and you're done :beers:
7070

7171
The `Common` test class in `test_jupyter.py`:
7272

73-
- Loads up a given `ipynb` fixture
73+
- Loads up a given `.ipynb` fixture
7474

75-
- Executes all code cells and converts it to HTML using the
75+
- Executes all code cells and converts them to HTML using the
7676
[`nbconvert`](https://nbconvert.readthedocs.io/en/latest/) and
7777
[`ipykernel`](http://ipython.readthedocs.io/en/stable/install/kernel_install.html)
78-
modules.
78+
modules.
7979

8080
- Saves the resulting HTML file is saved in `fixtures/` but is git-ignored.
8181

@@ -85,22 +85,22 @@ Then, `Common` runs an `npm` command in the shell:
8585
npm test -- <path-to-html-fixture> <path-to-js-test-file>
8686
```
8787

88-
which runs a minimal server using `lib/server.js`.
88+
which runs a minimal server using `lib/server.js`.
8989

9090
In details, `lib/server.js`:
9191

92-
- bundles up the js test code into a single bundle using
92+
- bundles up the `js` test code into a single bundle using
9393
[`browserify`](https://github.com/substack/node-browserify)
9494

95-
- stubs in a `<script>` tag to include the js test bundle in the fixture HTML
95+
- stubs in a `<script>` tag to include the `js` test bundle in the fixture HTML
9696

9797
- starts a simple http server
9898

9999
- launches Chrome at the HTML fixture URL
100100

101-
- once the page is loaded, the js tests are run and results are logged in the
101+
- once the page is loaded, the `js` tests are run and results are logged in the
102102
terminal
103103

104104

105-
See PR [#540](https://github.com/plotly/plotly.py/pull/549) for the details on
105+
See PR [#549](https://github.com/plotly/plotly.py/pull/549) for the details on
106106
how this suite was first implemented.

0 commit comments

Comments
 (0)