Skip to content

Commit

Permalink
Drop the obscure issue warning, and instead make the guidance stronger.
Browse files Browse the repository at this point in the history
  • Loading branch information
tonyandrewmeyer committed Jun 7, 2024
1 parent 931c9ba commit f331fb6
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions ops/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -1514,22 +1514,17 @@ def revoke(self, relation: 'Relation', *, unit: Optional[Unit] = None):
def remove_revision(self, revision: int):
"""Remove the given secret revision.
This is normally called when handling
This is normally only called when handling
:class:`ops.SecretRemoveEvent <ops.charm.SecretRemoveEvent>` or
:class:`ops.SecretExpiredEvent <ops.charm.SecretExpiredEvent>`.
If the charm does not have permission to remove the secret, or it no
longer exists, this method will succeed, but the unit will go into error
state on completion of the current Juju hook.
If the tracked revision is removed, then :meth:`get_content` should
be called immediately afterwards with ``refresh=True``, to avoid
leaving the unit in a 'stuck' state.
Args:
revision: The secret revision to remove. If being called from a
secret event, this should usually be set to
:attr:`SecretRemoveEvent.revision`.
revision: The secret revision to remove. This should usually be set to
:attr:`SecretRemoveEvent.revision` or :attr:`SecretExpiredEvent.revision`.
"""
if self._id is None:
self._id = self.get_info().id
Expand Down

0 comments on commit f331fb6

Please sign in to comment.