rest icon indicating copy to clipboard operation
rest copied to clipboard

Wording clarification in SeBootstrap.Instance.stop()

Open NicoNes opened this issue 3 years ago • 3 comments

Hi Guys,

I was reading your interesting talk here, then I started to have a look at the SeBootstrap.

I have a little question, not a big deal, about the use of both words "immediate" and "asynchronously" in the Instance.stop() javadoc method.

Is this method supposed to :

  • immediately shutdown the Instance ? In this case why do we need to return a CompletionStage<> that is "asynchronously shutting down this application instance" if it is immediate ?
  • initiate the shutdown method and return immediately ? In this case the CompletionStage<> makes sense.

IMO the second option is what is expected. So maybe removing the word "immediate" from the doc just like in the start method that also returns a CompletionStage<> will be more "simple to undertsand".

Thanks

NicoNes avatar Aug 26 '21 00:08 NicoNes

The second option. The shutdown is just initiated, this is a non-blocking method.

mkarg avatar Aug 26 '21 17:08 mkarg

Ok. So does it worth removing the "immediate" word in the doc or not to prevent confusion ?

NicoNes avatar Aug 26 '21 17:08 NicoNes

Ok. So does it worth removing the "immediate" word in the doc or not to prevent confusion ?

It depends if someone actually got or will be confused by it. No such case is known to me, but maybe others do or assume it will be an actual problem?

mkarg avatar Aug 28 '21 13:08 mkarg