in reply to Re^5: Meta-perl - sorting my perl subs with perl?
in thread Meta-perl - sorting my perl subs with perl?

Not really -- programmer documentation is for the programmer. "C-h f" shows the doc-string. If I want to see what a function does, I type "C-h f"; if I change a function, I edit the doc-string it contains. Emacs also has a manual -- written in the god-awful Texinfo format and updated by hand -- that provides higher-level documentation.

FWIW, I try to document my modules with POD next to each public function and a higher-level description at the end.

  • Comment on Re^6: Meta-perl - sorting my perl subs with perl?

Replies are listed 'Best First'.
Re^7: Meta-perl - sorting my perl subs with perl?
by JavaFan (Canon) on Jan 23, 2012 at 18:15 UTC
    Who is "the programmer" here? The person maintaining the function? Or the person using the function?

    Two different people. Two different sets of documentation. If it's only available using a specific editor, both people lose.

[reply]
      Who is "the programmer" here? The person maintaining the function? Or the person using the function?
      Obviously, the programmer is the person editing the function.
      Two different people. Two different sets of documentation. If it's only available using a specific editor, both people lose.
      If you're editing Emacs Lisp in something other than Emacs, you're an idiot.
[reply]
        Considering the site is about Perl, the thread mentions perl, and we're discussing where to place POD, where do you the impression from that we're talking about editing Emacs Lisp?

        I certainly am not.

[reply]

In Section Seekers of Perl Wisdom