Menu ▾ ▴

#3529 document: "chan close" == "close" etc.

obsolete: 8.5a5
closed-out-of-date
Donal K. Fellows
24. Channel Commands (103)
3
2008-03-21
2006-10-04
Anonymous
No

The current doucmentation for the new "chan"
subcommands does not mention that they are actually
implemented as aliases for the old commands.
So the behaviour:

% chan close foo
can not find channel named "foo"
% proc ::close args { puts "== $args ==" }
% chan close foo
== foo ==

... might be surprising.

In fact a new user may even wonder what the difference
is between for example "close ..." and "chan close ..."
And when to use one or the other!

Some suggestions:
1. document that they *are* aliases ie. the same
2. It might be worth putting the definition of the
::chan ensemble into the docs to illustrate (1)
3. make the "chan xxx" docs as links to the
original docs where this applies (keeps things in
sync and makes explicit that they are the same thing)
4. Also i noticed in the TIP208 that some of the
original commands might be marked as deprecated.
I cannot see any meantion of this in the docs.
Was this part rejected?
(i happen to think this is a good idea in theory,
although, it's not clear how to do this nicely :-)

Cheers, afredd.

Discussion

  • Donal K. Fellows

    Donal K. Fellows - 2006-10-05
    • milestone: --> obsolete: 8.5a5
    • priority: 5 --> 3
    • assigned_to: andreas_kupries --> dkf
     

  • Donal K. Fellows

    Donal K. Fellows - 2006-10-05

    Logged In: YES
    user_id=79902

    Redefining core commands so that they do something different
    *will* have very odd effects. But on the specific suggestions:

    1) There's no guarantee what we'll make them aliases to
    2) No. See response to 1
    3) Nroff doesn't do links; I've no control over what gets
    linked to what.
    4) Not rejected. "Not yet done" is more like it. :-)

     

  • Donal K. Fellows

    Donal K. Fellows - 2008-03-21
    • status: open --> closed-out-of-date
     

  • Donal K. Fellows

    Donal K. Fellows - 2008-03-21

    Logged In: YES
    user_id=79902
    Originator: NO

    In 8.5.0, the [chan] subcommands are not the same as the global commands (with the exception of [chan configure]/[fconfigure], for security reasons).