Skip to content

Commit b6e8c12

Browse files
Uniformize waiter (#541)
1 parent 105519c commit b6e8c12

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTION.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Inside `core` you can find several packages that are used by all service modules
3030

3131
### Implementing a module waiter
3232

33-
For integration with other tools such as the [STACKIT Terraform Provider](https://github.com/stackitcloud/terraform-provider-stackit) and the [STACKIT CLI](https://github.com/stackitcloud/stackit-cli), there is the need to implement `waiters` for some SDK modules. Waiters are routines for resources that are created/updated/deleted asynchronously, which wait until the creation/update/deletion of the specified resource is completed. The waiters are located in a folder named `wait` inside each service folder.
33+
For integration with other tools such as the [STACKIT Terraform Provider](https://github.com/stackitcloud/terraform-provider-stackit) and the [STACKIT CLI](https://github.com/stackitcloud/stackit-cli), there is the need to implement waiters for some SDK modules. Waiters are routines that wait for the completion of asynchronous operations. They are located in a folder named `wait` inside each service folder.
3434

3535
Let's suppose you want to implement the waiters for the `Create`, `Update` and `Delete` operations of a resource `bar` of service `foo`:
3636

@@ -163,7 +163,7 @@ func DeleteBarWaitHandler(ctx context.Context, a APIClientInterface, BarId, proj
163163
}
164164
```
165165

166-
- The main objective of the `wait` functions is to make sure that the operation was successful, which means any other special cases such as intermediate error states should also be handled
166+
- The main objective of the waiter functions is to make sure that the operation was successful, which means any other special cases such as intermediate error states should also be handled
167167

168168
## Code Contributions
169169

0 commit comments

Comments
 (0)