search

drforr / perl6-Perl6-Tidy

Tidier for Perl 6 code
16 stars 7 forks source link

Documentation error #8

Closed remorse closed 6 years ago

remorse commented 6 years ago

Hi! In the README.md file, you have a section which is supposed to demonstrate the different types of indentation styles. They all look the same, and based on the names, are (all) wrong, as they all are just one line.

(Also, could you include an if ... else statement, so that the demonstration demonstrates whether it created "cuddled elses"?)

drforr commented 6 years ago

Thanks for catching that; I need to learn GH style markdown or something. I'll take a look at it after I get back from supper/movie.

drforr commented 6 years ago

Uh, I definitely did not make those changes. App::Mi6 recreated my README.md file for me without my knowledge - I've added a dist.ini file that will stop that from happening and rebuilt something of the original file. Tempted to file a bug, but there's a setting for it. I just wish I'd caught it before it got released. Maybe there needs to be a prompt for "Check your files before release", but really the last "Do you want to release?" should act like that. I just needed to take advantage of it.

drforr commented 6 years ago

Released v0.0.3 with the updated documentation, so I'm closing this ticket.

Also, I'm going to create a separate flag for if-then-else that lets you set cuddling independent of formatting - the sub {} and if {} don't always go hand-in-hand, although I'll probably default to what the outer brace setting is.

I'll make that my next feature to add, I think, so I can get back into the habit of looking at the code. Hopefully going to need to do more of that in the near future anyway.

remorse commented 6 years ago

Thanks!