##// END OF EJS Templates
Grammatical fixes
Dave Willmer -
Show More
@@ -7,10 +7,10 b' IPython 6.0'
7 7
8 8 Released April 19th, 2017
9 9
10 IPython 6 feature a major improvement in the completion machinery which is now
10 IPython 6 features a major improvement in the completion machinery which is now
11 11 capable of completing non-executed code. It is also the first version of IPython
12 12 to stop compatibility with Python 2, which is still supported on the bugfix only
13 5.x branch. Read below to have a non-exhaustive list of new features.
13 5.x branch. Read below for a non-exhaustive list of new features.
14 14
15 15 Make sure you have pip > 9.0 before upgrading.
16 16 You should be able to update by using:
@@ -22,7 +22,7 b' You should be able to update by using:'
22 22
23 23 .. note::
24 24
25 If your pip version is greater of equal to pip 9.0.1 you will automatically get
25 If your pip version is greater than or equal to pip 9.0.1 you will automatically get
26 26 the most recent version of IPython compatible with your system: on Python 2 you
27 27 will get the latest IPython 5.x bugfix, while in Python 3
28 28 you will get the latest 6.x stable version.
@@ -30,20 +30,20 b' You should be able to update by using:'
30 30 New completion API and Interface
31 31 --------------------------------
32 32
33 The completer Completion API has seen an overhaul, and the new completer have
34 plenty of improvement both from the end users of terminal IPython or for
33 The completer Completion API has seen an overhaul, and the new completer has
34 plenty of improvements both from the end users of terminal IPython and for
35 35 consumers of the API.
36 36
37 37 This new API is capable of pulling completions from :any:`jedi`, thus allowing
38 type inference on non-executed code. If :any:`jedi` is installed completion like
39 the following are now becoming possible without code evaluation:
38 type inference on non-executed code. If :any:`jedi` is installed, completions like
39 the following are now possible without code evaluation:
40 40
41 41 >>> data = ['Number of users', 123_456]
42 42 ... data[0].<tab>
43 43
44 44 That is to say, IPython is now capable of inferring that `data[0]` is a string,
45 45 and will suggest completions like `.capitalize`. The completion power of IPython
46 will increase with new Jedi releases, and a number of bugs and more completions
46 will increase with new Jedi releases, and a number of bug-fixes and more completions
47 47 are already available on the development version of :any:`jedi` if you are curious.
48 48
49 49 With the help of prompt toolkit, types of completions can be shown in the
@@ -60,36 +60,36 b' The appearance of the completer is controlled by the'
60 60 type differently depending on the value among ``'column'``, ``'multicolumn'``
61 61 and ``'readlinelike'``
62 62
63 The use of Jedi also fulfills a number of requests and fix a number of bugs
64 like case-insensitive completion, completion after division operator: See
63 The use of Jedi also fulfills a number of requests and fixes a number of bugs
64 like case-insensitive completion and completion after division operator: See
65 65 :ghpull:`10182`.
66 66
67 67 Extra patches and updates will be needed to the :mod:`ipykernel` package for
68 68 this feature to be available to other clients like Jupyter Notebook, Lab,
69 69 Nteract, Hydrogen...
70 70
71 The use of Jedi is should be barely noticeable on recent enough machines, but
72 can be slower on older ones. To tweak the performances, the amount
71 The use of Jedi should be barely noticeable on recent machines, but
72 can be slower on older ones. To tweak the performance, the amount
73 73 of time given to Jedi to compute type inference can be adjusted with
74 ``c.IPCompleter.jedi_compute_type_timeout``. The objects whose type were not
74 ``c.IPCompleter.jedi_compute_type_timeout``. The objects whose type was not
75 75 inferred will be shown as ``<unknown>``. Jedi can also be completely deactivated
76 76 by using the ``c.Completer.use_jedi=False`` option.
77 77
78 78
79 79 The old ``Completer.complete()`` API is waiting deprecation and should be
80 replaced replaced by ``Completer.completions()`` in a near future. Feedback on
81 the current state of the API and suggestions welcome.
80 replaced replaced by ``Completer.completions()`` in the near future. Feedback on
81 the current state of the API and suggestions are welcome.
82 82
83 83 Python 3 only codebase
84 84 ----------------------
85 85
86 86 One of the large challenges in IPython 6.0 has been the adoption of a pure
87 Python 3 codebase, which leads us to great length to upstream patches in pip,
88 pypi and warehouse to make sure Python 2 system still upgrade to the latest
89 compatible Python version compatible.
87 Python 3 codebase, which has led to upstream patches in pip,
88 pypi and warehouse to make sure Python 2 systems still upgrade to the latest
89 compatible Python version.
90 90
91 91 We remind our Python 2 users that IPython 5 is still compatible with Python 2.7,
92 still maintained and get regular releases. Using pip 9+, upgrading IPython will
92 still maintained and will get regular releases. Using pip 9+, upgrading IPython will
93 93 automatically upgrade to the latest version compatible with your system.
94 94
95 95 .. warning::
@@ -109,12 +109,12 b' first time excluding the big split for 4.0). The decrease is potentially'
109 109 a bit more for the sour as some documents like this one are append only and
110 110 are about 300 lines long.
111 111
112 The removal as of Python2/Python3 shim layer has made the code quite clearer and
113 more idiomatic in a number of location, and much friendlier to work with and
114 understand. We hope to further embrace Python 3 capability in the next release
112 The removal of the Python2/Python3 shim layer has made the code quite a lot clearer and
113 more idiomatic in a number of locations, and much friendlier to work with and
114 understand. We hope to further embrace Python 3 capabilities in the next release
115 115 cycle and introduce more of the Python 3 only idioms (yield from, kwarg only,
116 general unpacking) in the code base of IPython, and see if we can take advantage
117 of these as well to improve user experience with better error messages and
116 general unpacking) in the IPython code base, and see if we can take advantage
117 of these to improve user experience with better error messages and
118 118 hints.
119 119
120 120
@@ -130,8 +130,8 b' team. See the project to bring back the readline interface: `rlipython'
130 130
131 131 This change will be backported to the IPython 5.x series.
132 132
133 Miscs improvements
134 ------------------
133 Misc improvements
134 -----------------
135 135
136 136
137 137 - The :cellmagic:`capture` magic can now capture the result of a cell (from
@@ -182,7 +182,7 b' development cycle marked for Milestone 6.0.'
182 182 `reload` into the interactive namespace have been removed. You have to
183 183 explicitly import `reload` from `IPython.lib.deepreload` to use it.
184 184
185 - The :magic:`profile` used to print current IPython profile in use, and which
185 - The :magic:`profile` used to print the current IPython profile, and which
186 186 was deprecated in IPython 2.0 does now raise a `DeprecationWarning` error when
187 used. It is often confused with the :magic:`prun` and the deprecation remove
187 used. It is often confused with the :magic:`prun` and the deprecation removal
188 188 should free up the ``profile`` name in future versions.
General Comments 0
You need to be logged in to leave comments. Login now