Re: A problem case for the site documentation search: the "^methods" method.

[Will Coleda]

Please open an issue for this at github.com/Raku/doc/issues

On Tue, Mar 2, 2021 at 8:12 PM Joseph Brenner  wrote:
>
> If you go to docs.raku.org and type "^methods" into the search
> window, you get a drop down looking something like this:
>
> class
>   Method
>   Submethod
>
> method
>   methods
>
> Reference
>  ^methods
>   methods
>   Submethods
>
> Routine
>   method
>
> Site Search
>   search entire site for ^methods
>
> There's a bunch of stuff in there I don't particularly want to
> see, but there's at least one entry that's definitely a hit:
>
>   Reference
> ^methods
>
> That takes you to here:
>
>   
> https://docs.raku.org/language/classtut#index-entry-$CIRCUMFLEX_ACCENTmethods
>
>
> On this, my browser leaves me at the top of the page, it doesn't jump
> to the internal label-- it's presumably missing from the page: and
> $CIRCUMFLEX_ACCENT is a variable that was supposed to interpolate
> but got treated as a literal.
>
> But anyway, I can do a text search for "^methods" now, and that
> takes me to this section, where there's some good material about
> "^methods":
>
>https://docs.raku.org/language/classtut#Introspection
>
> Every other entry in that drop down menu is a red herring.
> Particularly bad is the "search entire site" because it uses
> Google, and they don't treat characters like '^' as significant
> (once upon a time they had a "code search" feature, but it's
> long gone).
>
> There *are* other place whether "^methods" is mentioned in the
> documentation, but to find them I needed to do a git clone of
> the project and grep the source files on my hard drive:
>
> language/5to6-perlvar
> Language/operators
> Language/rb-nutshell
> Language/structures
> Type/ForeignCode
> Type/Metamodel/MethodContainer
> Type/Signature
> Type/Stash
>
> And actually, just the fact that the main search interface for
> the raku docs is a drop-down is a bit of an annoyance for me-- it
> no doubt seems very modern to some people, but I had to do a
> screen shot of it just to get it to sit still so I could type up
> the copy I included above.

Re: documentation of internals

[Joseph Brenner]

> I think it is best if you open an issue for this, so that it will not fall 
> through the cracks.

Okay, fair enough:

https://github.com/rakudo/rakudo/issues/4245

On 3/7/21, Elizabeth Mattijsen  wrote:
>> On 7 Mar 2021, at 00:16, Joseph Brenner  wrote:
>>
>> Is there anything like an equivalent of "man perlguts" for Raku/rakudo?
>>
>> There are things like this, but they seem to be very out-of-date:
>>
>>  https://github.com/rakudo/rakudo/blob/master/docs/architecture.html
>
> That is indeed severely out of date, some parts by almost a decade now.
>
> I don't think it is worthwile to update this, as things will change again
> when the RakuAST branch lands.
>
> I think it is best if you open an issue for this, so that it will not fall
> through the cracks.