Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 3.7.2

Request #19939 No documentation on rules
Submitted: 2013-05-08 01:25 UTC
From: astoyan Assigned: squiz
Status: Assigned Package: PHP_CodeSniffer (version 1.5.0RC2)
PHP Version: Irrelevant OS:
Roadmaps: (Not assigned)    
Subscription  


 [2013-05-08 01:25 UTC] astoyan (Alexander Stoyan)
Description: ------------ There is a way to define custom ruleset but there is no word about what rules are available and what properties they have. And developers are supposed to google on some hints, use someone's pieces, read source code in order to understand how how use this or that rule, or in order to find a rule needed. This is just stupid. Was it so hard to put a small txt file with the list of rules and their properties?

Comments

 [2013-05-08 04:53 UTC] squiz (Greg Sherwood)
-Assigned To: +Assigned To: squiz
Next time, try asking nicely. It makes people more likely to respond favourably to your requests. But yes, this is something I've been wanting to do for a while but have not yet had the time. I will certainly get to it eventually, but it depends on my other commitments. Ideally, I'd like to create a script to parse the sniffs for public variables and use their comments to generate the docs.
 [2013-05-08 05:21 UTC] astoyan (Alexander Stoyan)
Hello Greg, thank you for such a quick response. I'm sorry about my tone, it's nothing personal, but I was really badly surprised when noticed that one of number one tools is almost impossible to use. I mean, it's a tool of a large scale, used worldwide by huge community, and that was my first impression because I'm new to PHP world, and after spending about 4 hours trying to find any information while being on tight schedule, I just got angry. Also I wouldn't be so rude if I knew you work on this tool alone, I just saw a list of developers, 766 people, and it just looked to me as a truly neglectfulness when such a big community of developers cannot take care about such a simple stuff. Sorry me again, and thank you for creating such a useful tool.
 [2013-05-08 05:32 UTC] squiz (Greg Sherwood)
Thanks Alexander. I understand the frustration. It truly is on my todo list, as is the complete migration of all documentation to the github wiki (it is partially done).
 [2013-11-27 10:49 UTC] squiz (Greg Sherwood)
-Type: Documentation Problem +Type: Feature/Change Request