Skip to content

Commit

Permalink
add release date - update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ilanschnell committed Jan 1, 2024
1 parent 30fac55 commit 7188666
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion CHANGE_LOG
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
20XX-XX-XX 2.9.2:
2024-01-01 2.9.2:
-------------------
* optimize initialization from strings by not constantly resizing buffer
* optimize `util.hex2ba()` and `util.base2ba()` by avoiding unnecessary
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ license to reproduce, analyze, test, perform and/or display publicly,
prepare derivative works, distribute, and otherwise use bitarray
alone or in any derivative version, provided, however, that Ilan Schnell's
License Agreement and Ilan Schnell's notice of copyright, i.e., "Copyright (c)
2008 - 2023 Ilan Schnell; All Rights Reserved" are retained in bitarray
2008 - 2024 Ilan Schnell; All Rights Reserved" are retained in bitarray
alone or in any derivative version prepared by Licensee.

3. In the event Licensee prepares a derivative work that is based on
Expand Down
8 changes: 2 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,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.9.1
bitarray version: 2.9.2
sys.version: 3.11.0 (main, Oct 25 2022) [Clang 14.0.4]
sys.prefix: /Users/ilan/Mini3/envs/py311
pointer size: 64 bit
Expand Down Expand Up @@ -427,7 +427,7 @@ and can therefore be used as a dictionary key:
Reference
=========

bitarray version: 2.9.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
bitarray version: 2.9.2 -- `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.
Expand Down Expand Up @@ -865,8 +865,6 @@ This sub-module was added in version 1.2.
Return a string containing the base ``n`` ASCII representation of
the bitarray. Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
The bitarray has to be multiple of length 1, 2, 3, 4, 5 or 6 respectively.
For ``n=16`` (hexadecimal), ``ba2hex()`` will be much faster, as ``ba2base()``
does not take advantage of byte level operations.
For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
standard base 64 alphabet is used.

Expand All @@ -878,8 +876,6 @@ This sub-module was added in version 1.2.
``base2ba(n, asciistr, /, endian=None)`` -> bitarray
Bitarray of base ``n`` ASCII representation.
Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
For ``n=16`` (hexadecimal), ``hex2ba()`` will be much faster, as ``base2ba()``
does not take advantage of byte level operations.
For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
standard base 64 alphabet is used.

Expand Down
2 changes: 1 addition & 1 deletion bitarray/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2008 - 2023, Ilan Schnell; All Rights Reserved
# Copyright (c) 2008 - 2024, Ilan Schnell; All Rights Reserved
"""
This package defines an object type which can efficiently represent
a bitarray. Bitarrays are sequence types and behave very much like lists.
Expand Down
2 changes: 1 addition & 1 deletion bitarray/__init__.pyi
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2021 - 2023, Ilan Schnell; All Rights Reserved
# Copyright (c) 2021 - 2024, Ilan Schnell; All Rights Reserved
#
# This stub, as well as util.pyi, are tested with Python 3.9 and mypy 0.950

Expand Down
2 changes: 1 addition & 1 deletion bitarray/_bitarray.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (c) 2008 - 2023, Ilan Schnell; All Rights Reserved
Copyright (c) 2008 - 2024, Ilan Schnell; All Rights Reserved
bitarray is published under the PSF license.
This file is the C part of the bitarray package.
Expand Down
2 changes: 1 addition & 1 deletion bitarray/_util.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (c) 2019 - 2023, Ilan Schnell; All Rights Reserved
Copyright (c) 2019 - 2024, Ilan Schnell; All Rights Reserved
bitarray is published under the PSF license.
This file contains the C implementation of some useful utility functions.
Expand Down
2 changes: 1 addition & 1 deletion bitarray/bitarray.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (c) 2008 - 2023, Ilan Schnell; All Rights Reserved
Copyright (c) 2008 - 2024, Ilan Schnell; All Rights Reserved
bitarray is published under the PSF license.
Author: Ilan Schnell
Expand Down
2 changes: 1 addition & 1 deletion bitarray/util.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2019 - 2023, Ilan Schnell; All Rights Reserved
# Copyright (c) 2019 - 2024, Ilan Schnell; All Rights Reserved
# bitarray is published under the PSF license.
#
# Author: Ilan Schnell
Expand Down
2 changes: 1 addition & 1 deletion bitarray/util.pyi
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) 2021 - 2023, Ilan Schnell; All Rights Reserved
# Copyright (c) 2021 - 2024, Ilan Schnell; All Rights Reserved

from collections import Counter
from collections.abc import Iterable, Iterator, Sequence
Expand Down
8 changes: 8 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Change log
==========

**2.9.2** (2024-01-01):

* optimize initialization from strings by not constantly resizing buffer
* optimize ``util.hex2ba()`` and ``util.base2ba()`` by avoiding unnecessary
copies
* optimize ``util.base2ba()`` and ``util.ba2base()`` for ``n=16`` (hexadecimal)


**2.9.1** (2023-12-23):

* avoid buffer being unnecessarily initialized with 0s in several
Expand Down
6 changes: 1 addition & 5 deletions doc/reference.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Reference
=========

bitarray version: 2.9.1 -- `change log <https://github.com/ilanschnell/bitarray/blob/master/doc/changelog.rst>`__
bitarray version: 2.9.2 -- `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.
Expand Down Expand Up @@ -439,8 +439,6 @@ This sub-module was added in version 1.2.
Return a string containing the base ``n`` ASCII representation of
the bitarray. Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
The bitarray has to be multiple of length 1, 2, 3, 4, 5 or 6 respectively.
For ``n=16`` (hexadecimal), ``ba2hex()`` will be much faster, as ``ba2base()``
does not take advantage of byte level operations.
For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
standard base 64 alphabet is used.

Expand All @@ -452,8 +450,6 @@ This sub-module was added in version 1.2.
``base2ba(n, asciistr, /, endian=None)`` -> bitarray
Bitarray of base ``n`` ASCII representation.
Allowed values for ``n`` are 2, 4, 8, 16, 32 and 64.
For ``n=16`` (hexadecimal), ``hex2ba()`` will be much faster, as ``base2ba()``
does not take advantage of byte level operations.
For ``n=32`` the RFC 4648 Base32 alphabet is used, and for ``n=64`` the
standard base 64 alphabet is used.

Expand Down

0 comments on commit 7188666

Please sign in to comment.