Re: boo-boo in run docs?
[email protected] (ToddAndMargo via perl6-users) Sat, 15 Nov 2025 02:19:19 -0800
| Newsgroups | perl.perl6.users |
|---|---|
| Message-ID | <[email protected]> |
On 11/12/25 2:52 AM, Richard Hainsworth wrote: > > > On Sun, 9 Nov 2025, 04:27 ToddAndMargo via perl6-users, <perl6- > [email protected] <mailto:[email protected]>> wrote: > > On 11/8/25 11:59 AM, Richard Hainsworth wrote: > > Hi Todd, > > > > Long time since I responded to one of your questions. > > Snip > > > Hi Richard, > > I under stand why it is done that way. I just > do not like how it is done. > > We all have our likes and dislikes. > I know you document things with your keepers. But to be honest the ones > you have published contain errors because they gloss over important topics. > > For example in your next sentence: > > > "run" return its results in the OOP class "Proc". > > There is an error! 'run' does NOT return it's results in the OOP class > Proc!!! > > 'run' returns an object of type Proc. This is important because you can > have many objects but there is still only one class. And the difference > between type and class arises because (in Raku but not in many other > languages) you can add roles to an object which means it will do more > than just the methods of class Proc. > > And that is precisely what methods are documented by class and not by > the routines which return objects of that class. > > The whole point of the secondary files is to aid in finding relevant > information. > > But that is also the reason for the functionality in the search button. > > I think everyone agrees that search and the website could be improved. > > If you could find a way to suggest a systematic way of showing you how > to get the information you need in a more intuitive way, please let me know. > > I'm writing a new version of the docs website. Take a look at https:// > new-raku.finanayst.org <https://new-raku.finanayst.org> > > It looks a bit like the old one, but it works better on mobiles and tablets. > > There are bugs in it still. > > Currently I'm working on an upgrade to the RakuDoc Renderer, so the bugs > will be there for a bit. > > However I really would like to have a better search function. > > I wish the documentation would define what is > put into your Proc variable when "run" exits. > Not divide it up all over the place. > > Snip > > And, I should not have to find the source code > more readable and explanatory than the documents. > And that should tell you something! > > Thank you for the well written letter. > I appreciate it. > > -T > > Hi Richard, I am thinking. I will definitely get back to you in a few days. -T