Documentation of object.destroy

[Mike Franklin]

On Tuesday, 2 January 2018 at 13:58:49 UTC, Johan Engelen wrote:

> How about:
> "Destroys the given object `obj` and puts `obj` in its `T.init` 
> state. This function used to destroy an object such that any 
> cleanup by the destructor or finalizer is done, and such that 
> `obj` no longer references any other objects (unless `T.init` 
> references other objects). This function does not initiate a GC 
> cycle nor free any GC memory."

I think you meant "This function *is* used..."

I suggest the following:

Calls `obj`'s destructor and sets `obj` to its default initial 
state, `T.init`.  This function does not initiate a GC cycle nor 
does it free any GC memory.

Mike