Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement]: Document WithWaitStrategy option #2116

Closed
pablochacin opened this issue Jan 12, 2024 · 2 comments
Closed

[Enhancement]: Document WithWaitStrategy option #2116

pablochacin opened this issue Jan 12, 2024 · 2 comments
Labels
documentation Docs, docs, docs.

Comments

@pablochacin
Copy link
Contributor

pablochacin commented Jan 12, 2024

Proposal

The WithWaitStrategy option is not documented in the wait strategies section. It is only mentioned in the modules.

@pablochacin pablochacin added the enhancement New feature or request label Jan 12, 2024
@mdelapenya mdelapenya added documentation Docs, docs, docs. and removed enhancement New feature or request labels Jan 12, 2024
@pablochacin
Copy link
Contributor Author

pablochacin commented Jan 12, 2024

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

image

@mdelapenya
Copy link
Member

mdelapenya commented Jan 20, 2024

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Docs, docs, docs.
Projects
None yet
Development

No branches or pull requests

2 participants