azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[FIR] Add guidelines for diagnostic messages

Browse Source
This commit is contained in:
Kirill Rakhman
2023-05-24 17:30:08 +02:00
committed by Space Team
parent aacbcc9d49
commit 6cd9b5ec98
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
compiler/fir/checkers/src/org/jetbrains/kotlin/fir/analysis/diagnostics/FirErrorsDefaultMessages.kt
+11
View File
@@ -673,6 +673,17 @@ import org.jetbrains.kotlin.fir.analysis.diagnostics.FirErrors.WRONG_NUMBER_OF_T
import org.jetbrains.kotlin.fir.analysis.diagnostics.FirErrors.WRONG_SETTER_PARAMETER_TYPE
import org.jetbrains.kotlin.fir.analysis.diagnostics.FirErrors.WRONG_SETTER_RETURN_TYPE
/**
* ## Guidelines for diagnostic messages
*
* - Sentences and fragments should end with a full stop.
* - If a message has parameters, single quotes (') must be escaped by using double single quotes ('').
* Otherwise, text inside single quotes will not be formatted (see [java.text.MessageFormat]).
* - If a message has no parameters, no double single quotes should be used.
* [java.text.MessageFormat] won't be used under the hood, and so the double single quotes will be printed.
* - Parameters referring to the user's declarations should be quoted (with two single quotes).
* - Use single quotes (') instead of backticks (`) or double quotes (")
*/
@Suppress("unused")
object FirErrorsDefaultMessages : BaseDiagnosticRendererFactory() {