From 86cdfa0d2a4104a730bb681cc1e995afc185a6ba Mon Sep 17 00:00:00 2001 From: Simon Brandhof Date: Wed, 28 May 2014 11:41:55 +0200 Subject: [PATCH] SONAR-5007 improve description of api/rules/update --- .../java/org/sonar/server/rule/ws/UpdateAction.java | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java b/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java index df95bccbe30..5c07d6682ff 100644 --- a/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java +++ b/sonar-server/src/main/java/org/sonar/server/rule/ws/UpdateAction.java @@ -67,16 +67,18 @@ public class UpdateAction implements RequestHandler { .setExampleValue("javascript:NullCheck"); action.createParam(PARAM_TAGS) - .setDescription("Optional comma-separated list of tags to set. Use empty value to remove all current tags.") + .setDescription("Optional comma-separated list of tags to set. Use blank value to remove current tags. Tags " + + "are not changed if the parameter is not set.") .setExampleValue("java8,security"); action.createParam(PARAM_MARKDOWN_NOTE) - .setDescription("Optional note in markdown format. Use empty value to remove current note.") + .setDescription("Optional note in markdown format. Use empty value to remove current note. Note is not changed" + + "if the parameter is not set.") .setExampleValue("my *note*"); action.createParam(PARAM_DEBT_SUB_CHARACTERISTIC) - .setDescription("Optional key of the new sub-characteristic to set. Use empty value to unset (-> none) or '" + - RuleUpdate.DEFAULT_DEBT_CHARACTERISTIC + "' to revert to default sub-characteristic .") + .setDescription("Optional key of the debt sub-characteristic. Use empty value to unset (-> none) or '" + + RuleUpdate.DEFAULT_DEBT_CHARACTERISTIC + "' to revert to default sub-characteristic.") .setExampleValue("FAULT_TOLERANCE"); action.createParam(PARAM_DEBT_REMEDIATION_FN_TYPE) -- 2.39.5