You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I found they are actually documented in the modules section and also these common options are included in each module's documentation.
However, I would expect this options to be referenced from the features/wait page, as this is probably the first place where a user would find about wait strategies.
Also, they are not indexed properly and do not appear in the search
@pablochacin the WithWaitStrategy option is referenced for every container module, as you pointed out in #2116 (comment).
I'm not sure if adding it to the features/wait page would come with confusion, as that is a generic place for explaining what a wait strategy does, not explaining that a functional option exists for modules.
I know it's possible to manually call the functional option once you have the container request, but mixing up the two container types (generic and modules) would not be desired.
But once we have the new v1 API, where a container.New(ctx, ...opts) function would eventually appear, then for sure this option should be documented as a first citizen from the container configuration API.
Let's keep this issue open for that. Does it make sense to you?
Proposal
The
WithWaitStrategy
option is not documented in the wait strategies section. It is only mentioned in the modules.The text was updated successfully, but these errors were encountered: