docs: make pebble.Client.remove_path and Container.remove_path docs consistent #1031
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
benhoyt
reviewed
Oct 4, 2023
Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
Co-authored-by: Ben Hoyt <benhoyt@gmail.com>
benhoyt
reviewed
Oct 6, 2023
ops/pebble.py
Outdated
| @@ -2153,11 +2153,15 @@ def remove_path(self, path: str, *, recursive: bool = False): | |||
|
|
|||
| Args: | |||
| path: Path of the file or directory to delete from the remote system. | |||
| recursive: If True, and path is a directory recursively deletes it and | |||
| recursive: If True, and path is a directory, recursively deletes it and | |||
There was a problem hiding this comment.
Can we also please copy the new version above to here? "recursive" and "Raises".
|
The mysql-k8s-operator tests changed, will open a separate PR for addressing that. |
benhoyt
approved these changes
Oct 10, 2023
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.
pebble.Client.remove_pathtomodel.Container.remove_path(and fix a missing comma).remove_pathmay raisePathErrorin some situations.Annoyingly the Go docs are vague on when an error will occur. The pebble code seems to raise an error if the path is relative or if the underlying Go call does. I've kept the wording fairly generic as a result.
Fixes #699