Skip to content

Commit 61a6c1e

Browse files
committed
several typos corrected
1 parent bc96f16 commit 61a6c1e

File tree

7 files changed

+1011
-1497
lines changed

7 files changed

+1011
-1497
lines changed

Index.ipynb

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"metadata": {
3+
"name": "",
4+
"signature": "sha256:0b4b631419772e40e0f4893f5a0f0fe089a39e46c8862af0256164628394302d"
5+
},
6+
"nbformat": 3,
7+
"nbformat_minor": 0,
8+
"worksheets": [
9+
{
10+
"cells": [
11+
{
12+
"cell_type": "markdown",
13+
"metadata": {},
14+
"source": [
15+
"<img src=\"images/ipython_logo.png\">"
16+
]
17+
},
18+
{
19+
"cell_type": "heading",
20+
"level": 1,
21+
"metadata": {},
22+
"source": [
23+
"IPython Documentation"
24+
]
25+
},
26+
{
27+
"cell_type": "markdown",
28+
"metadata": {},
29+
"source": [
30+
"This directory contains IPython's notebook-based documentation. This augments our [Sphinx-based documentation](http://ipython.org/ipython-doc/stable/index.html) with notebooks that contain interactive tutorials and examples. Over time, more of our documentation will be pulled into this format."
31+
]
32+
},
33+
{
34+
"cell_type": "heading",
35+
"level": 2,
36+
"metadata": {},
37+
"source": [
38+
"Topics"
39+
]
40+
},
41+
{
42+
"cell_type": "markdown",
43+
"metadata": {},
44+
"source": [
45+
"* [IPython Kernel](IPython Kernel/Index.ipynb): IPython's core syntax and command line features available in all frontends\n",
46+
"* [Notebook](Notebook/Index.ipynb): The IPython Notebook frontend\n",
47+
"* [Interactive Widgets](Interactive Widgets/Index.ipynb): Interactive JavaScript/HTML widgets and `interact`\n",
48+
"* [Parallel Computing](Parallel Computing/Index.ipynb): IPython's library for interactive parallel computing\n",
49+
"* [Customization](Customization/Index.ipynb): How to configure IPython and customize it with magics, extensions, etc.\n",
50+
"* [Embedding](Embedding/Index.ipynb): Embedding and reusing IPython's components into other applications\n",
51+
"* [Builtin Extensions](Builtin Extensions/Index.ipynb): Extensions we ship with IPython"
52+
]
53+
}
54+
],
55+
"metadata": {}
56+
}
57+
]
58+
}

s00_homepage/s00_homepage.ipynb

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"metadata": {
33
"name": "",
4-
"signature": "sha256:978ec4a51adde88d163151ad46d48f1dc622138ebda6b86d3fc773f58103b1d7"
4+
"signature": "sha256:5ff5e1b71e1eeaa3bb6b00bc5769ecb09d334ee59ad78606cd9ccd24895a5477"
55
},
66
"nbformat": 3,
77
"nbformat_minor": 0,
@@ -70,7 +70,7 @@
7070
"cell_type": "markdown",
7171
"metadata": {},
7272
"source": [
73-
"The User Guide was written with the goal of giving Plotly's Python/IPython users extensive documentation on all of Plotly's features. \n",
73+
"The User Guide project has the goal of giving Plotly's Python/IPython users extensive documentation on all of Plotly's features. \n",
7474
"\n",
7575
"Whereas Plotly's web <a href=\"https://plot.ly/python\" target=\"_blank\">documentation</a> is meant to serve Plotly beginners\n",
7676
"just looking to make a simple plot and experienced users trying out a new plot type, \n",
@@ -92,7 +92,7 @@
9292
"metadata": {},
9393
"source": [
9494
"The User Guide assumes the latest version (v 1.0) of Plotly's Python API verison\n",
95-
"1.0. <br> The latest version features many improvements. For instance: \n",
95+
"1.0. <br> The latest version features several improvements. For instance: \n",
9696
"\n",
9797
"* A *get* function, to import data and styles from public figures on Plotly's servers, \n",
9898
"\n",
@@ -125,7 +125,7 @@
125125
"for notebook styling ideas.\n",
126126
"The Github <a href=\"https://github.com/plotly/python-user-guide\" target=\"_blank\">repository</a> is divided into folders, where each folder contains one IPython notebook and their required data files. You are currently reading the User Guide's homepage.\n",
127127
"\n",
128-
"Each section is intended to be a single *lecture*. While the content is mostly divided by plot types, each lecture contains valuable examples of Plotly's customization flexibility as well as templates that users can incorporate into their work.\n",
128+
"Each section is intended to be a single *lecture*. While the content is mostly divided by plot types, each lecture contains valuable examples of Plotly's customization flexibility as well as templates that users can incorporate into their own work.\n",
129129
"\n",
130130
"\n",
131131
"<h4 style=\"margin-top:20px;\">Current sections:</h4>\n",
@@ -231,7 +231,7 @@
231231
"\n",
232232
"<h5>Step 4</h5>\n",
233233
"\n",
234-
"Sign up for Plotly if you don't have an account already:\n",
234+
"If you don't already have an account, sign up for Plotly:\n",
235235
"\n",
236236
" * Go to [plot.ly](https://plot.ly/) and click on the *Sign up* button.\n",
237237
"\n",
@@ -249,7 +249,7 @@
249249
"\n",
250250
"<h5>Step 6</h5>\n",
251251
"\n",
252-
"For better code portability, we recommend setting up a *credentials* file:\n",
252+
"For better code portability, we recommend setting up a *credentials* file on your machine:\n",
253253
"\n",
254254
"* In Python or IPython,\n",
255255
"\n",
@@ -296,7 +296,7 @@
296296
"source": [
297297
"*And there you go.* You are now ready to make plots using Plotly and the Python API.\n",
298298
"\n",
299-
"Using the credentials file allows users to share code without having to type in (yet along remember) their own username and API key every time they want to generate a new or modify an existing Plotly plot."
299+
"Using the credentials file allows users to share code without having to type in (yet along remember) their own username and API key every time they want to generate a new Plotly plot or modify an existing Plotly plot."
300300
]
301301
},
302302
{
@@ -313,10 +313,10 @@
313313
"source": [
314314
"For users looking to use the User Guide as a static *reference*:\n",
315315
"\n",
316-
"* we recommend using the <a href=\"http://nbviewer.ipython.org/github/plotly/python-user-guide/blob/master/\">nbviewer.ipython.org</a> website, which displays IPython notebooks in your browser. \n",
317-
"All the notebooks of the User Guide where converted using the <a href=\"https://github.com/jiffyclub/open-in-nbviewer\" target=\"_blank\">Open in nbviewer</a> Chrome book extension. Big Thanks!\n",
316+
"* we recommend using the <a href=\"http://nbviewer.ipython.org/\">nbviewer.ipython.org</a> website, which displays IPython notebooks in your browser. \n",
317+
"All the notebooks making up the User Guide where converted using the <a href=\"https://github.com/jiffyclub/open-in-nbviewer\" target=\"_blank\">Open in nbviewer</a> Chrome book extension. Big Thanks!\n",
318318
"\n",
319-
"Users looking to use the User Guide as an interactive *tutorial* (i.e. users looking to learn by running and/or running the code cells):\n",
319+
"For users looking to use the User Guide as an interactive *tutorial* (i.e. users looking to learn by running and/or modifying the code cells):\n",
320320
"\n",
321321
"* we recommend cloning the entire Github <a href=\"https://github.com/plotly/python-user-guide\" target=\"_blank\">repository</a> to your local machine:\n",
322322
"\n",

0 commit comments

Comments
 (0)