From 059d08dd9585292adcf4a4af6251f85faa9052e5 Mon Sep 17 00:00:00 2001 From: nik Date: Wed, 20 Mar 2019 15:50:08 +0300 Subject: [PATCH] platform: update javadoc for FeedbackDescriptionProvider --- .../src/com/intellij/ide/FeedbackDescriptionProvider.kt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/platform/platform-impl/src/com/intellij/ide/FeedbackDescriptionProvider.kt b/platform/platform-impl/src/com/intellij/ide/FeedbackDescriptionProvider.kt index a26521a81776..51438dea1f49 100644 --- a/platform/platform-impl/src/com/intellij/ide/FeedbackDescriptionProvider.kt +++ b/platform/platform-impl/src/com/intellij/ide/FeedbackDescriptionProvider.kt @@ -9,7 +9,8 @@ import com.intellij.openapi.project.Project */ interface FeedbackDescriptionProvider { /** - * Return additional details which should be appended to the description of a created issue. + * Return additional details which should be appended to the description of a created issue. It's important to return `null` if your plugin + * isn't relevant for the passed `project` to avoid polluting created reports with unrelated data. */ fun getDescription(project: Project?): String? }