doc icon indicating copy to clipboard operation
doc copied to clipboard

$=finish not documented

Open remorse opened this issue 7 years ago • 8 comments

Hi! I'm trying to find some documentation about $=finish, but it doesn't seem to be documented anywhere specifically. Because Rakudo doesn't implement generic pod variables, it would be nice have some documentation about the one that it does implement.

(Actually, it look like $=pod should also do something, but I'm not sure what.)

Thanks, Ricky

remorse avatar Aug 29 '18 15:08 remorse

Actually, thinking about it a bit more, I think that really the whole section at https://docs.perl6.org/language/variables#index-entry-%24%3D needs to be rewritten. Pod variables are not implemented in Rakudo, and if you try =begin finish, it works, but doesn't stop at =end finish.

remorse avatar Aug 29 '18 15:08 remorse

We'll do what we can. Thanks for the report.

JJ avatar Aug 29 '18 15:08 JJ

I'm already working some of that, and I'll add the new stuff as well. I've been waiting on all doc changes until the various fixes are done, but, as we've done before, we can always add a NYI to a section (and maybe a note to the GH issue number).

tbrowder avatar Aug 29 '18 19:08 tbrowder

@tbrowder Does that mean that particular feature is not implemented yet?

JJ avatar Aug 31 '18 16:08 JJ

If =begin finish and =end finish don't match, could that be a bug? Is it peculiar to =finish or it happens with pretty much other word? Is that bug reported in Rakudo?

JJ avatar Mar 15 '19 14:03 JJ

I don't know, but my intuition is that unlike the other addressable pod blocks, =finish is supposed to be equivalent to p5's 'DATA' (or 'END') blocks, so it doesn't really have an end. Also, at least so far, it isn't made via =begin finish, but is just =finish.

remorse avatar Mar 15 '19 15:03 remorse

In the test above, the =finish block does not seem to be parsed as an actual pod block. Is that correct, @tbrowder ?

JJ avatar Mar 15 '19 15:03 JJ

The =finish is implemented, and @remorse is correct, it ends the parsing of the file. Also, correct: =begin finish and =end finish is just an ordinary named pod block. But neither $=finish nor $=Foo are implemented yet. However, $=pod is implemented.

tbrowder avatar Mar 15 '19 18:03 tbrowder