Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Correcting minor typos in README
  • Loading branch information
Paul Cochrane committed Jan 24, 2015
1 parent bea39ef commit 6ce94d0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README
@@ -1,6 +1,6 @@
p6doc -- an attempt to write something like 'perldoc' for Perl 6

A HTML version of this documenation can be found at http://doc.perl6.org/
An HTML version of this documentation can be found at http://doc.perl6.org/

With a Rakudo 'perl6' executable in PATH, try

Expand All @@ -25,7 +25,7 @@ Here are some ways to help us:
* add usage examples to existing documentation
* proofread and correct the documentation

The file WANTED has a list of particular documents that is known to be
The file WANTED has a list of particular documents that are known to be
missing.

--------
Expand Down Expand Up @@ -76,12 +76,13 @@ Wishlist stuff:
the operator. ("p6doc '%%'" returns the documentation for
&infix:<%%>.)

* Perl6 implementations could embed P<...> tags in their source
code that would then inline the corresponding entry from p6doc.
This would enable things like "&say.WHY" to (dynamically!)
retrieve the documentation string from p6doc, without having
* Perl6 implementations could embed P<...> tags in their source
code that would then inline the corresponding entry from p6doc.
This would enable things like "&say.WHY" to (dynamically!)
retrieve the documentation string from p6doc, without having
to duplicate the documentation in the CORE.setting sources
or to encode the documentation into the binaries.

Example:

# In Rakudo's src/core/IO.pm:
Expand All @@ -95,4 +96,3 @@ Wishlist stuff:
#= P<p6doc/&note>
sub note(|$) { ... }


0 comments on commit 6ce94d0

Please sign in to comment.