Skip to content

Commit

Permalink
Fixes IPython / Jupyter links
Browse files Browse the repository at this point in the history
  • Loading branch information
evhub committed Jun 24, 2016
1 parent 7c77590 commit a81a1ae
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
1. [Compatible Python Versions](#compatible-python-versions)
1. [Allowable Targets](#allowable-targets)
1. [`--strict` Mode](#--strict-mode)
1. [IPython/Jupyter Support](#ipythonjupyter-support)
1. [IPython/ Jupyter Support](#ipython-jupyter-support)
1. [Extension](#extension)
1. [Kernel](#kernel)
1. [Operators](#operators)
Expand Down Expand Up @@ -82,7 +82,7 @@ This documentation covers all the technical details of the [Coconut Programming

Coconut is a variant of [Python](https://www.python.org/) built for **simple, elegant, Pythonic functional programming**. Coconut syntax is a strict superset of Python 3 syntax. That means users familiar with Python will already be familiar with most of Coconut.

The Coconut compiler turns Coconut code into Python code. The primary method of accessing the Coconut compiler is through the Coconut command-line utility, which also features an interpreter for real-time compilation. In addition to the command-line utility, Coconut also supports the use of IPython/Jupyter notebooks.
The Coconut compiler turns Coconut code into Python code. The primary method of accessing the Coconut compiler is through the Coconut command-line utility, which also features an interpreter for real-time compilation. In addition to the command-line utility, Coconut also supports the use of IPython/ Jupyter notebooks.

While most of Coconut gets its inspiration simply from trying to make functional programming work in Python, additional inspiration came from [Haskell](https://www.haskell.org/), [CoffeeScript](http://coffeescript.org/), [F#](http://fsharp.org/), and [patterns.py](https://github.com/Suor/patterns).

Expand Down Expand Up @@ -207,7 +207,7 @@ If the `--strict` or `-s` flag is enabled, Coconut will throw errors on various

It is recommended that you use the `--strict` or `-s` flag if you are starting a new Coconut project, as it will help you write cleaner code.

### IPython/Jupyter Support
### IPython/ Jupyter Support

If you prefer [IPython](http://ipython.org/) (the python kernel for the [Jupyter](http://jupyter.org/) framework) to the normal Python shell, Coconut can be used as an IPython extension or Jupyter kernel.

Expand All @@ -217,7 +217,7 @@ If Coconut is used as an extension, a special magic command will send snippets o

#### Kernel

If Coconut is used as a kernel, all code in the console or notebook will be sent directly to Coconut instead of Python to be evaluated. The command `coconut --jupyter notebook` (or `coconut --ipython notebook`) will launch an IPython/Jupyter notebook using Coconut as the kernel and the command `coconut --jupyter console` (or `coconut --ipython console`) will launch an IPython/Jupyter console using Coconut as the kernel. Additionally, the command `coconut --jupyter` (or `coconut --ipython`) will add Coconut as a language option inside of all IPython/Jupyter notebooks, even those not launched with Coconut. This command may need to be re-run when a new version of Coconut is installed.
If Coconut is used as a kernel, all code in the console or notebook will be sent directly to Coconut instead of Python to be evaluated. The command `coconut --jupyter notebook` (or `coconut --ipython notebook`) will launch an IPython/ Jupyter notebook using Coconut as the kernel and the command `coconut --jupyter console` (or `coconut --ipython console`) will launch an IPython/ Jupyter console using Coconut as the kernel. Additionally, the command `coconut --jupyter` (or `coconut --ipython`) will add Coconut as a language option inside of all IPython/ Jupyter notebooks, even those not launched with Coconut. This command may need to be re-run when a new version of Coconut is installed.

## Operators

Expand Down
8 changes: 4 additions & 4 deletions HELP.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
1. [Starting Out](#starting-out)
1. [Using the Interpreter](#using-the-interpreter)
1. [Using the Compiler](#using-the-compiler)
1. [Using IPython / Jupyter](#using-ipython--jupyter)
1. [Using IPython/ Jupyter](#using-ipython-jupyter)
1. [Case Studies](#case-studies)
1. [Case Study 1: `factorial`](#case-study-1-factorial)
1. [Imperative Method](#imperative-method)
Expand Down Expand Up @@ -65,7 +65,7 @@ and much more!
At its very core, Coconut is a compiler that turns Coconut code into Python code. That means that anywhere where you can use a Python script, you can also use a compiled Coconut script. To access that core compiler, Coconut comes with a command-line utility, which can
- compile single Coconut files or entire Coconut projects,
- interpret Coconut code on-the-fly, and
- hook into existing Python applications like IPython / Jupyter.
- hook into existing Python applications like IPython/ Jupyter.

Installing Coconut, including all the features above, is drop-dead simple. Just

Expand Down Expand Up @@ -154,11 +154,11 @@ Compiling single files is not the only way to use the Coconut command-line utili

The Coconut compiler supports a large variety of different compilation options, the help for which can always be accessed by entering `coconut -h` into the command line. One of the most useful of these is `--linenumbers` (or `-l` for short). Using `--linenumbers` will add the line numbers of your source code as comments in the compiled code, allowing you to see what line in your source code corresponds to a line in the compiled code where an error is occurring, for ease of debugging.

### Using IPython / Jupyter
### Using IPython/ Jupyter

Although all different types of programming can benefit from using more functional techniques, scientific computing, perhaps more than any other field, lends itself very well to functional programming, an observation the case studies in this tutorial are very good examples of. To that end, Coconut aims to provide extensive support for the established tools of scientific computing in Python.

That means supporting IPython / Jupyter, as modern Python programming, particularly in the sciences, has gravitated towards the use of [IPython](http://ipython.org/) (the python kernel for the [Jupyter](http://jupyter.org/) framework) instead of the classic Python shell. Coconut supports being used both as a kernel for Jupyter notebooks and consoles, and as an extension inside of the IPython kernel.
That means supporting IPython/ Jupyter, as modern Python programming, particularly in the sciences, has gravitated towards the use of [IPython](http://ipython.org/) (the python kernel for the [Jupyter](http://jupyter.org/) framework) instead of the classic Python shell. Coconut supports being used both as a kernel for Jupyter notebooks and consoles, and as an extension inside of the IPython kernel.

To launch a Jupyter notebook with Coconut as the kernel, use the command
```
Expand Down

0 comments on commit a81a1ae

Please sign in to comment.