Skip to content

Commit

Permalink
Add a wishlist section to README. (This could be factored to somewher…
Browse files Browse the repository at this point in the history
…e else; but the README is short enough that it makes sense here for now.)
  • Loading branch information
pmichaud committed Jul 5, 2012
1 parent 7edf743 commit 31dc410
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README
Expand Up @@ -26,7 +26,7 @@ Here are some ways to help us:
* write a tool that renders the documentation as HTML
* proofread and correct the documentation

---------
--------

Some notes:

Expand All @@ -51,4 +51,38 @@ 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.

--------

Wishlist stuff:

* Search terms like ".any", "any()", "&any", "::Any", etc. can be
used to disambiguate whether information is sought on a method,
subroutine, type, etc.

* Searching for "Int.Bool" returns the documentation for the
inherited method "Numeric.Bool".

* Searching for an operator name returns the documentation for
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
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:

#= P<p6doc/&print>
sub print(|$) { ... }

#= P<p6doc/&say>
sub say(|$) { ... }

#= P<p6doc/&note>
sub note(|$) { ... }


0 comments on commit 31dc410

Please sign in to comment.