Improved rule description

This commit is contained in:
Tomi De Lucca
2019-06-21 16:36:23 -03:00
parent 4fca74b0e0
commit 6d9066067d

View File

@@ -19,7 +19,7 @@ Rules which enforce generally accepted best practices.
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>
<priority>4</priority>
</rule>
<rule name="UnavailableFunction"
@@ -28,7 +28,10 @@ Rules which enforce generally accepted best practices.
class="net.sourceforge.pmd.lang.swift.rule.bestpractices.UnavailableFunctionRule"
externalInfoUrl="http://pmd.github.io/pmd/pmd_rules_swift_bestpractices.html#unavailablefunction">
<description>
Unimplemented functions should be marked as unavailable.
Due to Objective-C and Swift interoperability some functions are often required to be implemented but
aren't really needed. Is extremely common that the sole implementation of the functions consist of throwing
a fatal error. Marking this functions as unavailable prevents them from being executed while still making
the compiler happy.
</description>
<priority>3</priority>
</rule>