Skip to content

Commit 57e839d

Browse files
committed
update readme fix changelog
1 parent 3da3b83 commit 57e839d

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Please refer to the [full documentation](https://django-typer.readthedocs.io/) f
3434

3535
## 🚨 Upgrade Notice
3636

37-
**There are breaking changes between 2.x and 3.x, mostly involving shell tab completion. [See the changelog for migration steps]()**.
37+
**There are breaking changes between 2.x and 3.x, mostly involving shell tab completion. [See the changelog for migration steps](https://django-typer.readthedocs.io/en/latest/changelog.html#migrating-from-2-x-to-3-x)**.
3838

3939
## Installation
4040

doc/source/changelog.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Change Log
55
==========
66

7-
v3.0.0 (202X-XX-XX)
7+
v3.0.0 (2024-02-16)
88
===================
99

1010
* Implemented `Completer for media files. <https://github.com/django-commons/django-typer/issues/175>`_
@@ -13,8 +13,8 @@ v3.0.0 (202X-XX-XX)
1313
* Implemented `Add print_return class field to enable/disable result printing <https://github.com/django-commons/django-typer/issues/167>`_
1414
* BREAKING `Default rich traceback should not show locals - its too much information. <https://github.com/django-commons/django-typer/issues/166>`_
1515
* Implemented `path completers should be configurable with a root directory other than cwd <https://github.com/django-commons/django-typer/issues/165>`_
16-
* Implemented `Migrate pyproject.toml to poetry 2 and portable project specifiers. <https://github.com/django-commons/django-typer/issues/164>_`
17-
* BREAKING `Split parsers.py and completers.py into submodules. <https://github.com/django-commons/django-typer/issues/163>_`
16+
* Implemented `Migrate pyproject.toml to poetry 2 and portable project specifiers. <https://github.com/django-commons/django-typer/issues/164>`_
17+
* BREAKING `Split parsers.py and completers.py into submodules. <https://github.com/django-commons/django-typer/issues/163>`_
1818
* Implemented `Model completer/parser should support returning the field value <https://github.com/django-commons/django-typer/issues/162>`_
1919
* Fixed `Model objects with null lookup fields should not be included in model field completion output <https://github.com/django-commons/django-typer/issues/160>`_
2020
* Implemented `Add a performance regression. <https://github.com/django-commons/django-typer/issues/157>`_
@@ -46,8 +46,8 @@ v3.0.0 (202X-XX-XX)
4646
Migrating from 2.x to 3.x
4747
-------------------------
4848

49-
* Imports from the django_typer namespace have been removed. You should now import from
50-
django_typer.management.
49+
* Imports from the ``django_typer`` namespace have been removed. You should now import from
50+
``django_typer.management``.
5151

5252
* The `name` parameter has been removed from
5353
:func:`django_typer.management.initialize()` and :func:`django_typer.management.Typer.callback()`.
@@ -99,9 +99,6 @@ Shell Completions
9999
the `shellcompletion install` command. To be extra safe you may want to uninstall the old
100100
scripts before updating, using the v2.x ``shellcompletion remove`` command.
101101

102-
* If you are using shell tab completions you will need to reinstall the completion scripts. using
103-
the `shellcompletion install` command.
104-
105102
* The interface to shellcompletion has changed. ``--shell`` is now an initialization option and
106103
``remove`` was renamed to ``uninstall``.:
107104

0 commit comments

Comments
 (0)