X-Git-Url: http://git.vpit.fr/?p=perl%2Fmodules%2Findirect.git;a=blobdiff_plain;f=README;h=d880a9cc19d6c4db11ae6e2a9840f443518b57ab;hp=8e09f1e615492f26b0009c78371c98481c03d1ef;hb=d8064d5f5037d23c51e6e62386f32e65cef50d33;hpb=2f6320d18a05f68146184ff2d27475871b803288 diff --git a/README b/README index 8e09f1e..d880a9c 100644 --- a/README +++ b/README @@ -2,7 +2,7 @@ NAME indirect - Lexically warn about using the indirect object syntax. VERSION - Version 0.02 + Version 0.08 SYNOPSIS no indirect; @@ -15,21 +15,23 @@ SYNOPSIS if (defied $foo) { ... } # croaks, note the typo DESCRIPTION - When enabled (or disabled as some may prefer, since you actually turn it - on by calling "no indirect"), this pragma warns about indirect object - syntax constructs that may have slipped into your code. This syntax is - now considered harmful, since its parsing has many quirks and its use is - error prone (when "sub" isn't defined, "sub $x" is actually interpreted - as "$x->sub"). + When enabled (or disabled as some may prefer to say, since you actually + turn it on by calling "no indirect"), this pragma warns about indirect + object syntax constructs that may have slipped into your code. This + syntax is now considered harmful, since its parsing has many quirks and + its use is error prone (when "sub" isn't defined, "sub $x" is actually + interpreted as "$x->sub"). It currently does not warn when the object is enclosed between braces (like "meth { $obj } @args") or for core functions ("print" or "say"). This may change in the future, or may be added as optional features that would be enabled by passing options to "unimport". + This module is not a source filter. + METHODS "unimport @opts" - Magically called when "no indirect @args" is encountered. Turns the + Magically called when "no indirect @opts" is encountered. Turns the module on. If @opts contains ':fatal', the module will croak on the first indirect syntax met. @@ -41,13 +43,15 @@ DEPENDENCIES XSLoader (standard since perl 5.006). - Tests require IPC::Cmd (standard since 5.9.5). +CAVEATS + "meth $obj" (no semicolon) at the end of a file won't be seen as an + indirect object syntax, although it will as soon as there is another + token before the end (as in "meth $obj;" or "meth $obj 1"). AUTHOR Vincent Pit, "", . - You can contact me by mail or on #perl @ FreeNode (vincent or - Prof_Vince). + You can contact me by mail or on "irc.perl.org" (vincent). BUGS Please report any bugs or feature requests to "bug-indirect at @@ -61,6 +65,9 @@ SUPPORT perldoc indirect + Tests code coverage report is available at + . + ACKNOWLEDGEMENTS Bram, for motivation and advices.