Skip to content

Commit

Permalink
docs: add links to api changelog (#473)
Browse files Browse the repository at this point in the history
Users must subscribe to our changelog, or they might not be notified
about additions, deprecations and removals.
  • Loading branch information
jooola authored Jan 31, 2025
1 parent aa2479d commit 55d6064
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ Official Hetzner Cloud python library.

The library's documentation is available at [hcloud-python.readthedocs.io](https://hcloud-python.readthedocs.io), the public API documentation is available at [docs.hetzner.cloud](https://docs.hetzner.cloud).

> [!IMPORTANT]
> Make sure to follow our API changelog available at
> [docs.hetzner.cloud/changelog](https://docs.hetzner.cloud/changelog) (or the RRS feed
> available at
> [docs.hetzner.cloud/changelog/feed.rss](https://docs.hetzner.cloud/changelog/feed.rss))
> to be notified about additions, deprecations and removals.
## Usage

Install the `hcloud` library:
Expand Down
5 changes: 5 additions & 0 deletions hcloud/_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ class Client:
The Hetzner Cloud API reference is available at https://docs.hetzner.cloud.
Make sure to follow our API changelog available at
https://docs.hetzner.cloud/changelog (or the RRS feed available at
https://docs.hetzner.cloud/changelog/feed.rss) to be notified about additions,
deprecations and removals.
**Retry mechanism**
The :attr:`Client.request` method will retry failed requests that match certain criteria. The
Expand Down

0 comments on commit 55d6064

Please sign in to comment.