Skip to content

Commit

Permalink
docs: use MaintenanceStatus for local issues (canonical#1397)
Browse files Browse the repository at this point in the history
`WaitingStatus` should be used when waiting on an integrated charm.
`MaintenanceStatus` should be used when waiting for something local to
the charm. We missed an example in `can_connect()` when clarifying the
statuses earlier in the year.
  • Loading branch information
tonyandrewmeyer authored Sep 27, 2024
1 parent 31d315a commit ce62847
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion ops/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -2352,7 +2352,7 @@ def can_connect(self) -> bool:
# Check that Pebble is still reachable now.
container = self.unit.get_container("example")
if not container.can_connect():
event.add_status(ops.WaitingStatus("Waiting for Pebble..."))
event.add_status(ops.MaintenanceStatus("Waiting for Pebble..."))
"""
try:
self._pebble.get_system_info()
Expand Down

0 comments on commit ce62847

Please sign in to comment.