Skip to content

Commit 55d6064

Browse files
authored
docs: add links to api changelog (#473)
Users must subscribe to our changelog, or they might not be notified about additions, deprecations and removals.
1 parent aa2479d commit 55d6064

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Official Hetzner Cloud python library.
1010

1111
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).
1212

13+
> [!IMPORTANT]
14+
> Make sure to follow our API changelog available at
15+
> [docs.hetzner.cloud/changelog](https://docs.hetzner.cloud/changelog) (or the RRS feed
16+
> available at
17+
> [docs.hetzner.cloud/changelog/feed.rss](https://docs.hetzner.cloud/changelog/feed.rss))
18+
> to be notified about additions, deprecations and removals.
19+
1320
## Usage
1421

1522
Install the `hcloud` library:

hcloud/_client.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ class Client:
8484
8585
The Hetzner Cloud API reference is available at https://docs.hetzner.cloud.
8686
87+
Make sure to follow our API changelog available at
88+
https://docs.hetzner.cloud/changelog (or the RRS feed available at
89+
https://docs.hetzner.cloud/changelog/feed.rss) to be notified about additions,
90+
deprecations and removals.
91+
8792
**Retry mechanism**
8893
8994
The :attr:`Client.request` method will retry failed requests that match certain criteria. The

0 commit comments

Comments
 (0)