Skip to content
This repository was archived by the owner on Feb 20, 2026. It is now read-only.

Commit 3002730

Browse files
committed
Improve changelog
1 parent f862549 commit 3002730

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Tools for nice user interfaces in the terminal.
55

66
.. image:: https://img.shields.io/travis/TankerHQ/python-cli-ui.svg?branch=master
77
:target: https://travis-ci.org/TankerHQ/python-cli-ui
8-
8+
99
.. image:: https://img.shields.io/pypi/pyversions/cli-ui.svg
1010
:target: https://pypi.org/project/cli-ui
11-
11+
1212
.. image:: https://img.shields.io/pypi/v/cli-ui.svg
1313
:target: https://pypi.org/project/cli-ui/
1414

docs/changelog.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,20 @@ Highlights
1919
~~~~~~~~~~
2020

2121
* **Breaking change**: Rename main package from ``ui`` to ``cli_ui``. This name is less likely to
22-
cause clash with existing code.
22+
cause clash with existing code::
2323

24+
# old (<= 0.7)
25+
import ui
26+
ui.info("This is", ui.green, "green")
2427

25-
* **Breaking change** Instead of hard-coding ANSI sequences names and values, use `colorama` instead.
26-
All existing names have been kept, but some of the values changed slighlty.
28+
# new (>= 0.8)
29+
import cli_ui
30+
cli_ui.info("This is", cli_ui.green, "green")
31+
32+
33+
34+
* **Breaking change**: use `colorama` instead of hard-coding ANSI sequences names and values
35+
of `cli_ui` constants. All existing names have been kept, but some of the values changed slighlty.
2736

2837
* ``ask_`` functions now take a variable number of tokens as first argument.
2938
This allows to color the prompt when requiring input from the user, for instance::

0 commit comments

Comments
 (0)