##// END OF EJS Templates
fill out client.shutdown docstring...
MinRK -
Show More
@@ -1134,8 +1134,26 b' class Client(HasTraits):'
1134 raise error
1134 raise error
1135
1135
1136 @spin_first
1136 @spin_first
1137 def shutdown(self, targets=None, restart=False, hub=False, block=None):
1137 def shutdown(self, targets='all', restart=False, hub=False, block=None):
1138 """Terminates one or more engine processes, optionally including the hub."""
1138 """Terminates one or more engine processes, optionally including the hub.
1139
1140 Parameters
1141 ----------
1142
1143 targets: list of ints or 'all' [default: all]
1144 Which engines to shutdown.
1145 hub: bool [default: False]
1146 Whether to include the Hub. hub=True implies targets='all'.
1147 block: bool [default: self.block]
1148 Whether to wait for clean shutdown replies or not.
1149 restart: bool [default: False]
1150 NOT IMPLEMENTED
1151 whether to restart engines after shutting them down.
1152 """
1153
1154 if restart:
1155 raise NotImplementedError("Engine restart is not yet implemented")
1156
1139 block = self.block if block is None else block
1157 block = self.block if block is None else block
1140 if hub:
1158 if hub:
1141 targets = 'all'
1159 targets = 'all'
General Comments 0
You need to be logged in to leave comments. Login now