Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
50 lines (32 sloc) 1.42 KB
p6doc -- an attempt to write something like 'perldoc' for Perl 6
So far only documentation for complete modules or classes is supported.
With a Rakudo 'perl6' executable in PATH, try
./bin/p6doc Str
to see the documentation for class Str, or
./bin/p6doc Str.split
to see the documentation for method split in class Str
--------
Help Wanted!
Perl 6 is not a small language, and documenting it takes a lot of effort.
Any help is appreciated.
Here are some ways to help us:
* add missing documentation for classes, roles, methods or operators
* add usage examples to existing documentation
* write a tool that renders the documentation as HTML
* proofread and correct the documentation
---------
Some notes:
Q: Why aren't you embedding the docs in the CORE sources?
A: Several reasons:
1. This documentation is intended to be universal with
respect to a given version of the specification,
and not necessarily tied to any specific Perl 6
implementation.
2. Implementations' handling of embedded POD is still
a bit uneven; this avoids potential runtime impacts.
3. A separate repo in the perl6 Github account invites
more potential contributors and editors.
Q: Which license is this stuff under?
A: Both code and documentation are available under the Artistic License 2.0
as published by The Perl Foundation. See the 'LICENSE' file for the full
text.
Jump to Line
Something went wrong with that request. Please try again.