Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

One of the Perl language servers, PLS, offers this capability to some extent. This should work with all editors/IDEs with language server support, in particular with VSCode.

In Emacs with lsp-mode, it shows the first line of the perldoc entry, in your example SHORT EXPLANATION IN ONE-LINE, in the minibuffer (as Eldoc usually does). This works for builtin functions and predefined variables, but is pretty useless for modules where the first line of the perldoc entry usually is the constant heading NAME.

PLS also offers the whole perldoc entry (markdown formatted) on request (in Emacs: M-x lsp-describe-thing-at-point). I am not too enthusiastic about this feature because hyperlinks in the perldoc text are resolved against which means you might not get the documentation which matches your installed version. Also, it doesn't work for modules in your current workspace.

The other Perl language servers either don't support hover or use it for different things - the specification does not clearly specify what should happen on hover. Caveat Emptor.

In reply to Re: Which IDE's show tooltips for Perl builtins? by haj
in thread Which IDE's show tooltips for Perl builtins? by LanX

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?

What's my password?
Create A New User
Domain Nodelet?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (4)
As of 2023-06-03 18:19 GMT
Find Nodes?
    Voting Booth?
    How often do you go to conferences?

    Results (16 votes). Check out past polls.