[Tcl-bugs] [ tcl-Bugs-3482614 ] Documentation - Tcl_GetReturnOptions contradiction/typo

[SourceForge.net <no...@so...>]

Bugs item #3482614, was opened at 2012-01-31 21:59
Message generated for change (Settings changed) made by dkf
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=110894&aid=3482614&group_id=10894

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Ashok P. Nadkarni (apnadkarni)
>Assigned to: Donal K. Fellows (dkf)
Summary: Documentation - Tcl_GetReturnOptions contradiction/typo

Initial Comment:
From the Tcl_GetReturnOptions documentation: "The (Tcl_Obj *) returned by Tcl_GetReturnOptions points to an unshared Tcl_Obj with reference count of zero. The dictionary may be written to, either adding, removing, or overwriting any entries in it, with the need to check for a shared object."

The "with" should be "without" ? Also, it might help if there was an explicit statement that the returned Tcl_Obj must be Tcl_DecrRefCount or otherwise disposed of. This is unlike Tcl_GetObjResult.

----------------------------------------------------------------------

>Comment By: Donal K. Fellows (dkf)
Date: 2012-02-01 05:05

Message:
Sorted out the bit which was wrong. Keeping open to consider the
"additional advice" part.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=110894&aid=3482614&group_id=10894