Skip to content

Feature request: include interactive-only clause in command docs #359

@Zoybean

Description

@Zoybean

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions