helpful icon indicating copy to clipboard operation
helpful copied to clipboard

New syntax to link to manpages when available

Open vermiculus opened this issue 7 years ago • 4 comments

It'd be really slick if we could link to manpages.

(defun my-crazy-function ()
  "Use Git configuration variables to do fancy things.

See (man)git-config."
  '(blah blah blah))

In normal help-mode buffers, it would obviously just show as (man)git-config. In helpful buffers, it could link out to the manpage if those facilities are available and if that page exists.

vermiculus avatar Feb 03 '18 15:02 vermiculus

Interesting idea! Are there projects that currently use this syntax, or are you proposing new syntax for docstrings?

Wilfred avatar Feb 07 '18 19:02 Wilfred

As far as I know, I'm proposing new syntax. It would be particularly useful for projects like Magit which wrap a large number of documented CLI tools.

vermiculus avatar Feb 07 '18 19:02 vermiculus

As of Emacs 28 there's an included link type for linking to man pages in docstrings! Heres the NEWS entry about it. It would really be great if helpful could format these links, and would be doubly helpful for older versions of emacs using newer packages that include these links in their docstrings.

zabe40 avatar May 27 '22 01:05 zabe40