Gruby perl

Jacek Konieczny jajcus w pld.org.pl
Sob, 27 Lip 2002, 18:08:25 CEST


On Sat, Jul 27, 2002 at 01:10:09PM +0200, Andrzej Krzysztofowicz wrote:
> > Dają dokładnie to samo. Podobnie ze wszystkimi modułami. Z tym że w
> > przypadku modułów dokumentacja jest ich częścią, więc pliki man są
> > nadmiarowe.
> 
> A moze odwrotnie?
> Czy *.pod maja jakas przewage nad manami ?
Przecież piszę: są częścią modułów (częścią ich kodu).
Masz moduł -> masz dokumentację. Dodatkowy man jest zbędny.

Dodatkowo są takie opcje perldoc, których man raczej nie ma:
       -m module
            Display the entire module: both code and unformatted pod documentation.  This
            may be useful if the docs don't explain a function in the detail you need, and
            you'd like to inspect the code directly; perldoc will find the file for you
            and simply hand it off for display.

       -f perlfunc
            The -f option followed by the name of a perl built in function will extract
            the documentation of this function from the perlfunc manpage.

       -q perlfaq
            The -q option takes a regular expression as an argument.  It will search the
            question headings in perlfaq[1-9] and print the entries matching the regular
            expression.

       PageName|ModuleName|ProgramName
            The item you want to look up.  Nested modules (such as "File::Basename") are
            specified either as "File::Basename" or "File/Basename".  You may also give a
            descriptive name of a page, such as "perlfunc". You may also give a partial or
            wrong-case name, such as "basename" for "File::Basename", but this will be
            slower, if there is more then one page with the same partial name, you will
            only get the first one.


Oczywiście były już pomysły wywalania dokumentacji z modułów (tracąc
oczywiście powyższą funkcjonalność), ale IMHO to bardzo głupi pomysł.
perldoc to _standardowy_ format dokumentacji dla perla. 
Może z modułów pythona wywalimy "docstrings" (brak "źródeł" modułów
pytonowych już nie raz mnie wkurzył, ale "docstrings" przynajmniej
częściowo ratowały sytuację), a całą dokumentację tetexa zamienimy na
plain-text?

Jak już ktoś koniecznie potrzebuje many, to niech będą w osobnym
pakiecie.

Pozdrowienia,
        Jacek



Więcej informacji o liście dyskusyjnej pld-devel-pl