Skip to content

Commit c3693f6

Browse files
author
Pietro Albini
committed
A better changelog for botogram 0.2
1 parent a990a69 commit c3693f6

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

docs/changelog.rst

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,41 @@ botogram 0.2
1616

1717
*Alpha release, not yet released*
1818

19+
botogram 0.2 is the second alpha release of botogram. It features an increased
20+
support for the upstream Telegram API, and also some bugfixes here and there.
21+
22+
This release also does some cleanup in the API, providing better methods and
23+
deprecating the old ones. The deprecated methods will be available until
24+
botogram 1.0, and warnings are in place to notify you where to change what.
25+
26+
New features
27+
------------
28+
1929
* Added the :py:attr:`botogram.User.name` computed attribute
2030
* Added the :py:attr:`botogram.Chat.name` computed attribute
2131
* Added the :py:attr:`botogram.User.avatar` attribute
2232
* Added the :py:meth:`botogram.User.avatar_history` method
23-
* Renamed ``Bot.init_shared_memory`` to ``Bot.prepare_memory``
33+
34+
Changes
35+
-------
36+
37+
* Renamed ``Bot.init_shared_memory`` to :py:meth:`botogram.Bot.prepare_memory`
2438
* Renamed ``Component.add_shared_memory_initializer`` to
25-
``Component.add_memory_preparer``
39+
:py:meth:`botogram.Component.add_memory_preparer`
40+
41+
Bug fixes
42+
---------
43+
2644
* Fix the syntax detector checking URLs with dashes in the domain (`issue 32`_)
2745
* Fix inability to send messages to channels from a running bot (`issue 35`_)
2846

29-
The following things are now **deprecated**:
47+
Deprecated features
48+
-------------------
49+
50+
Deprecated features will be removed in botogram 1.0!
3051

31-
* ``Bot.init_shared_memory``, and it will be removed in botogram 1.0
32-
* ``Component.add_shared_memory_initializer``, and it will be removed in
33-
botogram 1.0
52+
* ``Bot.init_shared_memory`` is now deprecated
53+
* ``Component.add_shared_memory_initializer`` is now deprecated
3454

3555
.. _issue 32: https://github.com/pietroalbini/botogram/issues/32
3656
.. _issue 35: https://github.com/pietroalbini/botogram/issues/35

0 commit comments

Comments
 (0)