Enhance rules description

This commit is contained in:
Matias Fraga
2019-06-21 13:26:08 -03:00
parent 93a52b7669
commit 499a31ca85
2 changed files with 5 additions and 2 deletions

View File

@@ -16,6 +16,8 @@ Rules which enforce generally accepted best practices.
externalInfoUrl="http://pmd.github.io/pmd/pmd_rules_swift_bestpractices.html#prohibitedinterfacebuilder">
<description>
Creating views using Interface Builder should be avoided.
Defining views by code allows the compiler to detect issues that otherwise will be runtime errors.
It's difficult to review the auto-generated code and allow concurrent modifications of those files.
</description>
<priority>2</priority>
</rule>

View File

@@ -16,7 +16,8 @@
class="net.sourceforge.pmd.lang.rule.XPathRule"
externalInfoUrl="http://pmd.github.io/pmd/pmd_rules_swift_errorprone.html#forcecast">
<description>
Force casts should be avoided.
Force casts should be avoided. This may lead to a crash if it's not used carefully.
For example assuming a JSON property has a given type, or your reused Cell has a certain contract.
</description>
<priority>3</priority>
<properties>
@@ -38,7 +39,7 @@
class="net.sourceforge.pmd.lang.rule.XPathRule"
externalInfoUrl="http://pmd.github.io/pmd/pmd_rules_swift_errorprone.html#forcetry">
<description>
Force tries should be avoided.
Force tries should be avoided. If the code being wrapped happens to raise and exception, our application will crash.
</description>
<priority>3</priority>
<properties>