search

metaeducation / ren-c

Library for embedding a Rebol interpreter into C codebases
GNU Lesser General Public License v3.0
127 stars 27 forks source link

help for -- is self referencing #1036

Open gchiu opened 4 years ago

gchiu commented 4 years ago

USAGE: ‌ -- :value :extra ‌ ‌DESCRIPTION: ‌ Show the name of a value or expressions with the value (See Also: --) ‌ -- is an ACTION!

hostilefork commented 4 years ago

As mentioned in chat, this arises because the "See Also" is nothing particularly intelligent about the HELP system having a "See Also" feature. It is just in the description string for DUMP:

https://github.com/metaeducation/ren-c/blob/370af9a69bbe7bf7abcce68df6bc549c37f0ad28/src/mezz/mezz-dump.r#L16

But -- is a function that is derived from DUMP, and hence inherits its help.

It can be worked around with REDESCRIBE. But the easiest thing to do is probably not to be trying to jury-rig a "See Also" feature into the system by manually putting it in the description.

Editing out the "See Also" is probably the best choice at this point in time. People will probably meet -- before they ever meet DUMP anyway.