Clarify documentation of container removal flags #498
Merged
Conversation
This file contains 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
This commit removes the `remove` flag from the docstring entirely, as the create() operation doesn't support the `remove` flag. It is tolerated as an input because run() supports it and it internally calls the start() operation relaying its own kwargs. Signed-off-by: Riccardo Paolo Bestetti <pbl@bestov.io>
This commit specifies more in depth the semantics of the `remove` flag of the run() operation: - it describes its interaction with detach=True - it clarifies that it is a client-initiated operation - it specifies that a similar daemon-side flag also exists with the name of `auto_remove` Signed-off-by: Riccardo Paolo Bestetti <pbl@bestov.io>
7edab3c to
7eaad53
Compare
|
/approve |
|
/approve |
inknos
approved these changes
Jan 16, 2025
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: inknos, rhatdan, vmsh0 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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.
This addresses the issue described in detail in #496, by updating the docstring for the
create()andrun()operations of Container.