File tree Expand file tree Collapse file tree 2 files changed +8
-5
lines changed Expand file tree Collapse file tree 2 files changed +8
-5
lines changed Original file line number Diff line number Diff line change 22
22
23
23
.. autoclass :: rez_pip.pip.DownloadedArtifact
24
24
:members:
25
+
26
+ .. autoclass :: rez_pip.plugins.CleanupAction
27
+ :members:
Original file line number Diff line number Diff line change @@ -35,14 +35,14 @@ def __dir__() -> typing.List[str]:
35
35
@dataclasses .dataclass (frozen = True )
36
36
class CleanupAction :
37
37
"""
38
- Cleanup hook action. If you want to to any cleanup from a cleanup hook
39
- you need ot return this.
38
+ Cleanup hook action. If you want to do any cleanup from a cleanup hook
39
+ you need to return this from the :func:`cleanup` hook .
40
40
"""
41
41
42
42
#: Operation to perform.
43
43
op : typing .Literal ["remove" ]
44
44
45
- #: Path to on which to perform the operation.
45
+ #: Path on which to perform the operation.
46
46
path : str
47
47
48
48
@@ -101,8 +101,8 @@ def cleanup( # type: ignore[empty-body]
101
101
self , dist : rez_pip .compat .importlib_metadata .Distribution , path : str
102
102
) -> rez_pip .compat .Sequence [CleanupAction ]:
103
103
"""
104
- Cleanup a package post-installation. Do not do any files/directories from this hook.
105
- rez-pip will take care of deleting stuff for you .
104
+ Cleanup a package post-installation. Do not delete any files/directories from this hook.
105
+ Return the list of actions you want to perform and let rez-pip perform them .
106
106
107
107
:param dist: Python distribution.
108
108
:param path: Root path of the rez variant.
You can’t perform that action at this time.
0 commit comments