update docs

adr26 · Jun 11, 2021 · 7a45266 · 7a45266
1 parent c496899
commit 7a45266
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -62,7 +62,7 @@ Once you have installed the package, you may want to test it:
 
     $ python -c 'import bitarray; bitarray.test()'
     bitarray is installed in: /Users/ilan/bitarray/bitarray
-    bitarray version: 2.1.0
+    bitarray version: 2.1.1
     sys.version: 2.7.15 (default, Mar  5 2020, 14:58:04) [GCC Clang 9.0.1]
     sys.prefix: /Users/ilan/Mini3/envs/py27
     pointer size: 64 bit
@@ -401,7 +401,7 @@ and can therefore be used as a dictionary key:
 Reference
 =========
 
-bitarray version: 2.1.0 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 2.1.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
 
 In the following, ``item`` and ``value`` are usually a single bit -
 an integer 0 or 1.
@@ -633,7 +633,7 @@ Functions defined in the `bitarray` module:
 
 ``get_default_endian()`` -> string
    Return the default endianness for new bitarray objects being created.
-   Under normal circumstances, the return value is ``big``.
+   Unless ``_set_default_endian()`` is called, the return value is ``big``.
 
 
 ``test(verbosity=1, repeat=1)`` -> TextTestResult
@@ -679,7 +679,7 @@ Functions defined in `bitarray.util` module:
 
 
 ``count_n(a, n, /)`` -> int
-   Return the smallest index ``i`` for which ``a[:i].count() == n``.
+   Return lowest index ``i`` for which ``a[:i].count() == n``.
    Raises ``ValueError``, when n exceeds total count (``a.count()``).
 
 

diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -1,13 +1,19 @@
 Change log
 ==========
 
+**2.1.1** (2021-06-11):
+
+* add type hinting (see PEP 484, 561) using stub (``.pyi``) files
+* add tests
+
+
 **2.1.0** (2021-05-05):
 
 * add ``.find()`` method, see `#122 <https://github.com/ilanschnell/bitarray/issues/122>`__
 * ``.find()``, ``.index()``, ``.search()`` and ``.itersearch()`` now all except
   both (sub-) bitarray as well as bool items to be searched for
 * improve encode/decode error messages
-* add `lexicographical  permutations example <../examples/lexico.py>`__
+* add `lexicographical permutations example <../examples/lexico.py>`__
 * add tests
 
 

diff --git a/doc/reference.rst b/doc/reference.rst
@@ -1,7 +1,7 @@
 Reference
 =========
 
-bitarray version: 2.1.0 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
+bitarray version: 2.1.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
 
 In the following, ``item`` and ``value`` are usually a single bit -
 an integer 0 or 1.
@@ -233,7 +233,7 @@ Functions defined in the `bitarray` module:
 
 ``get_default_endian()`` -> string
    Return the default endianness for new bitarray objects being created.
-   Under normal circumstances, the return value is ``big``.
+   Unless ``_set_default_endian()`` is called, the return value is ``big``.
 
 
 ``test(verbosity=1, repeat=1)`` -> TextTestResult
@@ -279,7 +279,7 @@ Functions defined in `bitarray.util` module:
 
 
 ``count_n(a, n, /)`` -> int
-   Return the smallest index ``i`` for which ``a[:i].count() == n``.
+   Return lowest index ``i`` for which ``a[:i].count() == n``.
    Raises ``ValueError``, when n exceeds total count (``a.count()``).