Skip to content

hiroraba/doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 documentaiton for method split in class Str

---------

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.

About

Perl 6 documentation (tools and docs)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Other 82.0%
  • CSS 11.3%
  • HTML 2.1%
  • Shell 1.5%
  • JavaScript 1.3%
  • Perl 1.1%
  • Makefile 0.7%