Skip to content

Bump version to 3.0.0 #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Changelog

## 3.0.0 (10/27/2021)

### Breaking

We have moved from [argcomplete](https://github.com/kislyuk/argcomplete) to [shtab](https://github.com/iterative/shtab) for
providing shell completions. This library is more efficient on doing tab completion, avoiding costly time it takes for the python
intrepreter to parse tldr to get options.

See [Readme#autocomplete](https://github.com/tldr-pages/tldr-python-client#autocomplete) for details on setting up shtab. Please
see the [argcomplete README](https://github.com/kislyuk/argcomplete) for details on where to look to remove its provided completions.

### Features

* __breaking__ Move to shtab for tab completion support (thanks [@casperdcl](https://github.com/casperdcl))
* Change default max cache age from 1 day to 7 days, can get prior behavior by setting the `TLDR_CACHE_MAX_AGE` environment variable
* Install manpage in pypi package
* Add option to print raw markdown (thanks [@dadav](https://github.com/dadav))
* Support Python 3.10

## 2.0.0 (07/19/2021)

### Features
Expand Down
2 changes: 1 addition & 1 deletion tldr.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import colorama # Required for Windows
import shtab

__version__ = "2.0.0"
__version__ = "3.0.0"
__client_specification__ = "1.4"

REQUEST_HEADERS = {'User-Agent': 'tldr-python-client'}
Expand Down