BUGS.md

   1 # Perltidy open BUGS and LIMITATIONS
   2
   3 You can help perltidy evolve into a better program.  If you think you
   4 have hit a bug or weird behavior, or have a suggested improvement,
   5 please send a note to perltidy at users.sourceforge.net.
   6
   7 This file only lists open bugs.  For bugs which have been fixed,
   8 see the ChangeLog.
   9
  10 ## The --extrude and --mangle options can produce code with syntax errors
  11
  12 The --extrude tries to put as many newlines in the formatted code as possible.
  13 The --mangle tries to remove as many newlines as possible.  These options are
  14 very useful for stress testing perltidy (and Perl) but not so much for normal
  15 formatting.  Occasionally they will produce code which Perl considers to have a
  16 syntax error.  These problems often involve code where Perl is having to guess
  17 the tokenization based on whitespace.  The given/when and switch/case
  18 statements are also particularly vulnerable to unusual line breaks and
  19 whitespace.  This type of error should not normally occur in practice, but if
  20 it does it should be easy to fix the problem by rerunning perltidy with more
  21 normal parameters or by manually changing whitespace or newlines.
  22
  23 ## The Pod:Html module has some bugs
  24
  25 For the most part Pod::Html works very well and is very convenient because
  26 it part of the standard Perl distribution.  But for example the following line
  27
  28     =item B<< <Deck> = Session->new_cflt_deck; >>
  29
  30 which uses double brackets to contain single brackets does not render correctly.
  31
  32 ## Two iterations are sometimes needed
  33
  34 Usually the code produced by perltidy on the first pass does not change if it
  35 is run again, but sometimes a second pass will produce some small additional
  36 change.  This mainly happens if a major style change is made, particularly when
  37 perltidy is untangling complex ternary statements. Use the iteration parameter
  38 **-it=2** if it is important that the results be unchanged on subsequent passes,
  39 but note that this doubles the run time.
  40
  41 ## Latest Bug and Wishlist at CPAN:
  42
  43 For the latest list of bugs and feature requests at CPAN see:
  44
  45 https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy