Skip to content

Commit

Permalink
Fix ambiguous sphinx any-refs
Browse files Browse the repository at this point in the history
  • Loading branch information
webknjaz committed May 14, 2020
1 parent 7db5942 commit 7283cf2
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
18 changes: 11 additions & 7 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ Bugfixes

- Fixed creating and updating of MultiDict from a sequence of pairs and keyword arguments. Previously passing a list argument modified it inplace, and other sequences caused an error.
`#457 <https://github.com/aio-libs/multidict/issues/457>`_
- Fixed comparing with mapping: an exception raised in the `__len__` method caused raising a SyntaxError.
- Fixed comparing with mapping: an exception raised in the
:py:func:`~object.__len__` method caused raising a SyntaxError.
`#459 <https://github.com/aio-libs/multidict/issues/459>`_
- Fixed comparing with mapping: all exceptions raised in the `__getitem__` method were silenced.
- Fixed comparing with mapping: all exceptions raised in the
:py:func:`~object.__getitem__` method were silenced.
`#460 <https://github.com/aio-libs/multidict/issues/460>`_


Expand All @@ -37,7 +39,8 @@ Bugfixes
Bugfixes
--------

- ``MultiDict.iter`` fix memory leak when used iterator over `multidict` instance.
- ``MultiDict.iter`` fix memory leak when used iterator over
:py:mod:`multidict` instance.
`#452 <https://github.com/aio-libs/multidict/issues/452>`_


Expand Down Expand Up @@ -81,7 +84,7 @@ Bugfixes

- Fix crashing when multidict is used pyinstaller
`#432 <https://github.com/aio-libs/multidict/issues/432>`_
- Fix typing for `CIMultiDict.copy`
- Fix typing for :py:meth:`CIMultiDict.copy`
`#434 <https://github.com/aio-libs/multidict/issues/434>`_
- Fix memory leak in ``MultiDict.copy()``
`#443 <https://github.com/aio-libs/multidict/issues/443>`_
Expand All @@ -96,13 +99,14 @@ Bugfixes
Bugfixes
--------

- `CIMultiDictProxy.copy` return object type `multidict._multidict.CIMultiDict`
- :py:meth:`CIMultiDictProxy.copy` return object type
:py:class:`multidict._multidict.CIMultiDict`
`#427 <https://github.com/aio-libs/multidict/issues/427>`_
- Make `CIMultiDict` subclassable again
- Make :py:class:`CIMultiDict` subclassable again
`#416 <https://github.com/aio-libs/multidict/issues/416>`_
- Fix regression, multidict can be constructed from arbitrary iterable of pairs again.
`#418 <https://github.com/aio-libs/multidict/issues/418>`_
- `CIMultiDict.add` may be called with keyword arguments
- :py:meth:`CIMultiDict.add` may be called with keyword arguments
`#421 <https://github.com/aio-libs/multidict/issues/421>`_


Expand Down
14 changes: 8 additions & 6 deletions docs/benchmark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ the `perf <https://perf.readthedocs.io>`_ module.
How to run
----------

`requirements/dev.txt` should be installed before we can proceed
``requirements/dev.txt`` should be installed before we can proceed
with benchmarks. Please also make sure that you have
`configured <https://perf.readthedocs.io/en/latest/system.html>`_
your OS to have reliable results.
Expand All @@ -26,25 +26,27 @@ To run benchmarks next command can be executed:
$ python benchmarks/benchmark.py
This would run benchmarks for both classes (:class:`MultiDict` and
:class:`CIMultiDict`) of both implementations (`Python` and `Cython`).
:class:`CIMultiDict`) of both implementations (``Python`` and
``Cython``).

To run benchmarks for a specific class of specific implementation
please use `--impl` option:
please use ``--impl`` option:

.. code-block:: bash
$ python benchmarks/benchmark.py --impl multidict_cython
would run benchmarks only for :class:`MultiDict` implemented in `Cython`.
would run benchmarks only for :class:`MultiDict` implemented
in ``Cython``.

Please use `--help` to see all available options. Most of the options are
Please use ``--help`` to see all available options. Most of the options are
described at `perf's Runner <https://perf.readthedocs.io/en/latest/runner.html>`_
documentation.

How to compare implementations
------------------------------

`--impl` option allows to run benchmarks for a specific implementation of
``--impl`` option allows to run benchmarks for a specific implementation of
class. Combined with the
`compare_to <https://perf.readthedocs.io/en/latest/cli.html#compare-to-cmd>`_
command of :mod:`perf` module we can get a good picture of how implementation
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ PyPI contains binary wheels for Linux, Windows and MacOS. If you want to instal
Tarball will be used to compile the library from sources. It requires C compiler and
Python headers installed.

To skip the compilation please use `MULTIDICT_NO_EXTENSIONS` environment variable,
To skip the compilation please use :data:`MULTIDICT_NO_EXTENSIONS` environment variable,
e.g.:

.. code-block:: bash
Expand Down

0 comments on commit 7283cf2

Please sign in to comment.