helpful icon indicating copy to clipboard operation
helpful copied to clipboard

Feature request: include interactive-only clause in command docs

Open Zoybean opened this issue 4 months ago • 0 comments

When viewing the helpful buffer for a function declared as interactive-only, the displayed documentation should include the snippet saying "this function is for interactive use only; in Lisp code use foo' instead." (or similar) which is presented in the corresponding describe` buffer.

i don't have a strong opinion of where this clause should go, whether it gets its own section or is added to the Documentation section.

Workarounds:

the helpful buffer already shows symbol properties in its own section, so the information is available, but not promiment.

Note:

I don't know if there are other symbol properties that usually add to the documentation that are not yet implemented in helpful. There may be some opportunity for code reuse if so.

Zoybean avatar Aug 21 '25 02:08 Zoybean