diff --git a/docs/source/config/integrating.rst b/docs/source/config/integrating.rst index a045968..07429ef 100644 --- a/docs/source/config/integrating.rst +++ b/docs/source/config/integrating.rst @@ -135,7 +135,7 @@ Metadata ^^^^^^^^ We often want to provide frontends with guidance on how to display the data. To -support this, ``_repr_*_()`` methods (except `_repr_pretty_``?) can also return a ``(data, metadata)`` +support this, ``_repr_*_()`` methods (except ``_repr_pretty_``?) can also return a ``(data, metadata)`` tuple where ``metadata`` is a dictionary containing arbitrary key-value pairs for the frontend to interpret. An example use case is ``_repr_jpeg_()``, which can be set to return a jpeg image and a ``{'height': 400, 'width': 600}`` dictionary diff --git a/docs/source/index.rst b/docs/source/index.rst index 9cec057..ebef06f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,9 +17,9 @@ interactively. Its main components are: * A powerful interactive Python shell. -.. image:: ./_images/ipython-6-screenshot.png - :alt: Screenshot of IPython 6.0 - :align: center + .. image:: ./_images/ipython-6-screenshot.png + :alt: Screenshot of IPython 6.0 + :align: center * A `Jupyter `_ kernel to work with Python code in Jupyter diff --git a/docs/source/whatsnew/github-stats-0.11.rst b/docs/source/whatsnew/github-stats-0.11.rst index 2f647ce..8fd4680 100644 --- a/docs/source/whatsnew/github-stats-0.11.rst +++ b/docs/source/whatsnew/github-stats-0.11.rst @@ -51,9 +51,9 @@ Pull requests (226): * `542 `_: issue 440 * `533 `_: Remove unused configobj and validate libraries from externals. * `538 `_: fix various tests on Windows -* `540 `_: support `-pylab` flag with deprecation warning +* `540 `_: support ``-pylab`` flag with deprecation warning * `537 `_: Docs update -* `536 `_: `setup.py install` depends on setuptools on Windows +* `536 `_: ``setup.py install`` depends on setuptools on Windows * `480 `_: Get help mid-command * `462 `_: Str and Bytes traitlets * `534 `_: Handle unicode properly in IPython.zmq.iostream diff --git a/docs/source/whatsnew/github-stats-2.0.rst b/docs/source/whatsnew/github-stats-2.0.rst index 5033994..98e3d5e 100644 --- a/docs/source/whatsnew/github-stats-2.0.rst +++ b/docs/source/whatsnew/github-stats-2.0.rst @@ -916,7 +916,7 @@ Pull Requests (687): * :ghpull:`4444`: Css cleaning * :ghpull:`4523`: Use username and password for MongoDB on ShiningPanda * :ghpull:`4510`: Update whatsnew from PR files -* :ghpull:`4441`: add `setup.py jsversion` +* :ghpull:`4441`: add ``setup.py jsversion`` * :ghpull:`4518`: Fix for race condition in url file decoding. * :ghpull:`4497`: don't automatically unpack datetime objects in the message spec * :ghpull:`4506`: wait for empty queues as well as load-balanced tasks @@ -1050,7 +1050,7 @@ Pull Requests (687): * :ghpull:`4214`: engine ID metadata should be unicode, not bytes * :ghpull:`4232`: no highlight if no language specified * :ghpull:`4218`: Fix display of SyntaxError when .py file is modified -* :ghpull:`4207`: add `setup.py css` command +* :ghpull:`4207`: add ``setup.py css`` command * :ghpull:`4224`: clear previous callbacks on execute * :ghpull:`4180`: Iptest refactoring * :ghpull:`4105`: JS output area misaligned diff --git a/docs/source/whatsnew/version0.9.rst b/docs/source/whatsnew/version0.9.rst index 81ebba1..8d5f73c 100644 --- a/docs/source/whatsnew/version0.9.rst +++ b/docs/source/whatsnew/version0.9.rst @@ -81,7 +81,7 @@ New features :mod:`IPython.kernel`, :mod:`IPython.kernel.core`, :mod:`traitlets.config`, :mod:`IPython.tools` and :mod:`IPython.testing`. -* As part of merging in the `ipython1-dev` stuff, the `setup.py` script and +* As part of merging in the `ipython1-dev` stuff, the ``setup.py`` script and friends have been completely refactored. Now we are checking for dependencies using the approach that matplotlib uses. @@ -161,7 +161,7 @@ Backwards incompatible changes `'basic'` to `'b'`. * IPython has a larger set of dependencies if you want all of its capabilities. - See the `setup.py` script for details. + See the ``setup.py`` script for details. * The constructors for :class:`IPython.kernel.client.MultiEngineClient` and :class:`IPython.kernel.client.TaskClient` no longer take the (ip,port) tuple. diff --git a/docs/source/whatsnew/version8.rst b/docs/source/whatsnew/version8.rst index 6ad4da1..b88dfb4 100644 --- a/docs/source/whatsnew/version8.rst +++ b/docs/source/whatsnew/version8.rst @@ -16,9 +16,6 @@ IPython 8.3.0 - :ghpull:`13600`, ``pre_run_*``-hooks will now have a ``cell_id`` attribute on the info object when frontend provide it. - - :ghpull:`13624`, fixed :kbd:`End` key being broken after accepting an - autosuggestion. - .. _version 8.2.0: IPython 8.2.0 @@ -519,8 +516,8 @@ Automatic Vi prompt stripping When pasting code into IPython, it will strip the leading prompt characters if there are any. For example, you can paste the following code into the console - -it will still work, even though each line is prefixed with prompts (`In`, -`Out`):: +it will still work, even though each line is prefixed with prompts (``In``, +``Out``):: In [1]: 2 * 2 == 4 Out[1]: True @@ -615,7 +612,7 @@ who did a fantastic job at updating our code base, migrating to pytest, pushing our coverage, and fixing a large number of bugs. I highly recommend contacting them if you need help with C++ and Python projects. -You can find all relevant issues and PRs with the SDG 2021 tag ``__ +You can find all relevant issues and PRs with `the SDG 2021 tag `__ Removing support for older Python versions ------------------------------------------