New Rule documentation

40 views
Skip to first unread message

Joris Dauphin

unread,
Nov 7, 2013, 1:01:28 PM11/7/13
to oclin...@googlegroups.com
Since new rules are coming,
what is the process to include some documentation ?
(I think about online, and maybe a method in `oclint --help-rule rulename`)
- What is the meaning of the rule.
- How to rewrite code to avoid the warning.
And so on.

Longyi Qi

unread,
Nov 14, 2013, 9:23:46 AM11/14/13
to Joris Dauphin, oclin...@googlegroups.com
Hi Joris,
We have document online at http://docs.oclint.org/en/dev/rules/index.html, and I am thinking to have the document packed into the release bundle start from the coming release. 

If people would like to help contribute to the document as well, simply fork https://github.com/oclint/oclint-docs and send pull requests. Appreciate it in advance.

Sincerely,
Longyi



--
You received this message because you are subscribed to the Google Groups "OCLint Dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to oclint-dev+...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Reply all
Reply to author
Forward
0 new messages