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

Fix javadoc for stop method #6834

Merged
merged 3 commits into from
Nov 28, 2023

Conversation

big-andy-coates
Copy link
Contributor

Not necessarily a fix for #1000, but at least make it easier for people to discover how to gracefully stop a container and/or send it different signals.

If/when this is merged, I'll leave it up to the committers to choose if #1000 should be closed, or if there is still intent to change the API. If the latter, I'm happy to raise a PR if someone gives brief guidance as to what api would be acceptable...

Make it clear `stop` actually kills the container in Docker terminology. Include  details of how to gracefully _stop_ the container, or send other signals.
@big-andy-coates big-andy-coates requested a review from a team as a code owner March 30, 2023 18:34
@eddumelendez eddumelendez added this to the next milestone Nov 28, 2023
@eddumelendez eddumelendez changed the title Improve JavaDoc on GenericContainer Fix javadoc for stop method Nov 28, 2023
@eddumelendez eddumelendez merged commit 7bf5c49 into testcontainers:main Nov 28, 2023
88 checks passed
@eddumelendez
Copy link
Member

Thanks for your contribution, @big-andy-coates ! I've proceed with the description Kill and remove the container. for now. I think the suggestions about graceful shutdown should be described in the docs rather than the javadoc itself along with the use case description.

@big-andy-coates big-andy-coates deleted the issue-1000 branch November 29, 2023 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants