Skip to content

Commit 31dc410

Browse files
committed
Add a wishlist section to README. (This could be factored to somewhere else; but the README is short enough that it makes sense here for now.)
1 parent 7edf743 commit 31dc410

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Here are some ways to help us:
2626
* write a tool that renders the documentation as HTML
2727
* proofread and correct the documentation
2828

29-
---------
29+
--------
3030

3131
Some notes:
3232

@@ -51,4 +51,38 @@ A: Both code and documentation are available under the Artistic License 2.0
5151
as published by The Perl Foundation. See the 'LICENSE' file for the full
5252
text.
5353

54+
--------
55+
56+
Wishlist stuff:
57+
58+
* Search terms like ".any", "any()", "&any", "::Any", etc. can be
59+
used to disambiguate whether information is sought on a method,
60+
subroutine, type, etc.
61+
62+
* Searching for "Int.Bool" returns the documentation for the
63+
inherited method "Numeric.Bool".
64+
65+
* Searching for an operator name returns the documentation for
66+
the operator. ("p6doc '%%'" returns the documentation for
67+
&infix:<%%>.)
68+
69+
* Perl6 implementations could embed P<...> tags in their source
70+
code that would then inline the corresponding entry from p6doc.
71+
This would enable things like "&say.WHY" to (dynamically!)
72+
retrieve the documentation string from p6doc, without having
73+
to duplicate the documentation in the CORE.setting sources
74+
or to encode the documentation into the binaries.
75+
Example:
76+
77+
# In Rakudo's src/core/IO.pm:
78+
79+
#= P<p6doc/&print>
80+
sub print(|$) { ... }
81+
82+
#= P<p6doc/&say>
83+
sub say(|$) { ... }
84+
85+
#= P<p6doc/&note>
86+
sub note(|$) { ... }
87+
5488

0 commit comments

Comments
 (0)