docs: add WithApplication and action waiting to code example #808
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The code example in our README.md only contained a minimal example showing how to set up the client and make a simple GET request. This introduces two additional "features" to the example: 1. We sometimes get support requests from users who forget to wait for the returned actions and expect the server (or other resource) to be immediately ready. 2. We regularly get support requests from users where the rate limit is exhausted by tools that do not identify themselves. This makes it hard to help users, as we are missing information. By showing the best-practices for both of these cases in the example, I hope that more people adopt them and have a better experience overall. Additionally I added the example to the go package docs for `hcloud`, so it also shows up on pkgs.go.dev for the package.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #808 +/- ##
=======================================
Coverage 79.41% 79.41%
=======================================
Files 60 60
Lines 4566 4566
=======================================
Hits 3626 3626
Misses 637 637
Partials 303 303 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
jooola
approved these changes
Jan 19, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The code example in our README.md only contained a minimal example showing how to set up the client and make a simple GET request.
This introduces two additional "features" to the example:
We sometimes get support requests from users who forget to wait for the returned actions and expect the server (or other resource) to be immediately ready.
We regularly get support requests from users where the rate limit is exhausted by tools that do not identify themselves. This makes it hard to help users, as we are missing information.
By showing the best-practices for both of these cases in the example, I hope that more people adopt them and have a better experience overall.
Additionally I added the example to the go package docs for
hcloud, so it also shows up on pkgs.go.dev for the package.