Skip to content

Commit

Permalink
Improve wording
Browse files Browse the repository at this point in the history
  • Loading branch information
asvetlov committed Sep 7, 2016
1 parent ede3422 commit 465862a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
14 changes: 9 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ multidict
Multidicts are useful for working with HTTP headers, URL
query args etc.

The code was extracted from aiohttp library.
The code was extracted from aiohttp_ library.

Introduction
------------

*HTTP Headers* and *URL query string* require specific data structure:
*multidict*. It behaves mostly like a ``dict`` but it can have
*multidict*. It behaves mostly like a regular ``dict`` but it may have
several *values* for the same *key*.

``multidict`` has four multidict classes:
``MultiDict``, ``MultiDictProxy``, ``CIMultiDict``
and ``CIMultiDictProxy``.

Immutable proxies (``MultiDictProxy`` and
``CIMultiDictProxy``) provide a dynamic view on the
``CIMultiDictProxy``) provide a dynamic view for the
proxied multidict, the view reflects underlying collection changes. They
implement the ``collections.abc.Mapping`` interface.

Expand All @@ -29,7 +29,7 @@ their own content.


*Case insensitive* (``CIMultiDict`` and
``CIMultiDictProxy``) ones assumes the *keys* are case
``CIMultiDictProxy``) ones assume the *keys* are case
insensitive, e.g.::

>>> dct = CIMultiDict(key='val')
Expand All @@ -40,10 +40,14 @@ insensitive, e.g.::

*Keys* should be ``str`` or ``istr`` instances.

The library has optional Cython optimization for sake of speed.
The library has optional Cython_ optimization for sake of speed.


License
-------

Apache 2


.. _aiohttp: https://github.com/KeepSafe/aiohttp
.. _Cython: https://cython.org/
9 changes: 5 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ Introduction
------------

*HTTP Headers* and *URL query string* require specific data structure:
*multidict*. It behaves mostly like a :class:`dict` but it can have
*multidict*. It behaves mostly like a regular :class:`dict` but it may have
several *values* for the same *key*.

:mod:`multidict` has four multidict classes:
:class:`MultiDict`, :class:`MultiDictProxy`, :class:`CIMultiDict`
and :class:`CIMultiDictProxy`.

Immutable proxies (:class:`MultiDictProxy` and
:class:`CIMultiDictProxy`) provide a dynamic view on the
:class:`CIMultiDictProxy`) provide a dynamic view for the
proxied multidict, the view reflects underlying collection changes. They
implement the :class:`~collections.abc.Mapping` interface.

Expand All @@ -33,7 +33,7 @@ their own content.


*Case insensitive* (:class:`CIMultiDict` and
:class:`CIMultiDictProxy`) ones assumes the *keys* are case
:class:`CIMultiDictProxy`) ones assume the *keys* are case
insensitive, e.g.::

>>> dct = CIMultiDict(key='val')
Expand All @@ -44,7 +44,7 @@ insensitive, e.g.::

*Keys* should be either :class:`str` or :class:`istr` instance.

The library has optional Cython optimization for sake of speed.
The library has optional Cython_ optimization for sake of speed.

Library Installation
--------------------
Expand Down Expand Up @@ -99,3 +99,4 @@ Indices and tables
* :ref:`search`

.. _GitHub: https://github.com/aio-libs/multidict
.. _Cython: https://cython.org/

0 comments on commit 465862a

Please sign in to comment.