Fix descriptions and names for processing parameters

nyalldawson · nyalldawson · commit 09e5a4f7bead · 2018-03-15T13:54:06.000+10:00
diff --git a/src/core/processing/qgsprocessingparametertypeimpl.h b/src/core/processing/qgsprocessingparametertypeimpl.h
@@ -71,7 +71,7 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorLayer : public QgsProcessingPa
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "A vector layer parameter." );
+      return QCoreApplication::translate( "Processing", "A vector layer parameter, e.g. for algorithms which change layer styles, edit layers in place, or other operations which affect an entire layer." );
     }
 
     virtual QString name() const override
@@ -251,7 +251,7 @@ class CORE_EXPORT QgsProcessingParameterTypeExtent : public QgsProcessingParamet
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "An extent defines a rectangle." );
+      return QCoreApplication::translate( "Processing", "A map extent parameter." );
     }
 
     virtual QString name() const override
@@ -311,7 +311,7 @@ class CORE_EXPORT QgsProcessingParameterTypeFile : public QgsProcessingParameter
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "A file input parameter." );
+      return QCoreApplication::translate( "Processing", "A file parameter, for use with non-map layer file sources." );
     }
 
     virtual QString name() const override
@@ -346,7 +346,7 @@ class CORE_EXPORT QgsProcessingParameterTypeField : public QgsProcessingParamete
 
     virtual QString name() const override
     {
-      return QCoreApplication::translate( "Processing", "Field" );
+      return QCoreApplication::translate( "Processing", "Vector Field" );
     }
 
     virtual QString id() const override
@@ -372,11 +372,7 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorDestination : public QgsProces
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "A vector layer destination parameter, "
-                                          "for specifying the destination path for a vector layer "
-                                          "created by the algorithm. "
-                                          "Consider using the more flexible QgsProcessingParameterFeatureSink "
-                                          "wherever possible." );
+      return QCoreApplication::translate( "Processing", "A vector layer destination parameter." );
     }
 
     virtual QString name() const override
@@ -420,9 +416,7 @@ class CORE_EXPORT QgsProcessingParameterTypeFileDestination : public QgsProcessi
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "A generic file based destination parameter, "
-                                          "for specifying the destination path for a file (non-map layer) "
-                                          "created by the algorithm.." );
+      return QCoreApplication::translate( "Processing", "A generic file based destination parameter." );
     }
 
     virtual QString name() const override
@@ -467,9 +461,7 @@ class CORE_EXPORT QgsProcessingParameterTypeFolderDestination : public QgsProces
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "A folder destination parameter, "
-                                          "for specifying the destination path for a folder created "
-                                          "by the algorithm or used for creating new files within the algorithm." );
+      return QCoreApplication::translate( "Processing", "A folder destination parameter." );
     }
 
     virtual QString name() const override
@@ -513,9 +505,7 @@ class CORE_EXPORT QgsProcessingParameterTypeRasterDestination : public QgsProces
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "A raster layer destination parameter, "
-                                          "for specifying the destination path for a raster layer "
-                                          "created by the algorithm." );
+      return QCoreApplication::translate( "Processing", "A raster layer destination parameter." );
     }
 
     virtual QString name() const override
@@ -593,7 +583,7 @@ class CORE_EXPORT QgsProcessingParameterTypeMultipleLayers : public QgsProcessin
 
     virtual QString name() const override
     {
-      return QCoreApplication::translate( "Processing", "Multiple Layers" );
+      return QCoreApplication::translate( "Processing", "Multiple Input" );
     }
 
     virtual QString id() const override
@@ -618,16 +608,12 @@ class CORE_EXPORT QgsProcessingParameterTypeFeatureSource : public QgsProcessing
 
     virtual QString description() const override
     {
-      return QCoreApplication::translate( "Processing", "An input feature source (such as vector layers) "
-                                          "parameter for processing algorithms. "
-                                          "This is the preferred way to pass features into an algorithm. "
-                                          "It can be directly connected to outputs (feature sinks) from "
-                                          "other algorithms and does not necessarily require an intermediate layer." );
+      return QCoreApplication::translate( "Processing", "A vector feature parameter, e.g. for algorithms which operate on the features within a layer." );
     }
 
     virtual QString name() const override
     {
-      return QCoreApplication::translate( "Processing", "Feature Source" );
+      return QCoreApplication::translate( "Processing", "Vector Features" );
     }
 
     virtual QString id() const override

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorLayer : public QgsProcessingPa`
`71`	`71`
`72`	`72`	`virtual QString description() const override`
`73`	`73`	`{`
`74`		`- return QCoreApplication::translate( "Processing", "A vector layer parameter." );`
	`74`	`+ return QCoreApplication::translate( "Processing", "A vector layer parameter, e.g. for algorithms which change layer styles, edit layers in place, or other operations which affect an entire layer." );`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`virtual QString name() const override`
`@@ -251,7 +251,7 @@ class CORE_EXPORT QgsProcessingParameterTypeExtent : public QgsProcessingParamet`
`251`	`251`
`252`	`252`	`virtual QString description() const override`
`253`	`253`	`{`
`254`		`- return QCoreApplication::translate( "Processing", "An extent defines a rectangle." );`
	`254`	`+ return QCoreApplication::translate( "Processing", "A map extent parameter." );`
`255`	`255`	`}`
`256`	`256`
`257`	`257`	`virtual QString name() const override`
`@@ -311,7 +311,7 @@ class CORE_EXPORT QgsProcessingParameterTypeFile : public QgsProcessingParameter`
`311`	`311`
`312`	`312`	`virtual QString description() const override`
`313`	`313`	`{`
`314`		`- return QCoreApplication::translate( "Processing", "A file input parameter." );`
	`314`	`+ return QCoreApplication::translate( "Processing", "A file parameter, for use with non-map layer file sources." );`
`315`	`315`	`}`
`316`	`316`
`317`	`317`	`virtual QString name() const override`
`@@ -346,7 +346,7 @@ class CORE_EXPORT QgsProcessingParameterTypeField : public QgsProcessingParamete`
`346`	`346`
`347`	`347`	`virtual QString name() const override`
`348`	`348`	`{`
`349`		`- return QCoreApplication::translate( "Processing", "Field" );`
	`349`	`+ return QCoreApplication::translate( "Processing", "Vector Field" );`
`350`	`350`	`}`
`351`	`351`
`352`	`352`	`virtual QString id() const override`
`@@ -372,11 +372,7 @@ class CORE_EXPORT QgsProcessingParameterTypeVectorDestination : public QgsProces`
`372`	`372`
`373`	`373`	`virtual QString description() const override`
`374`	`374`	`{`
`375`		`- return QCoreApplication::translate( "Processing", "A vector layer destination parameter, "`
`376`		`- "for specifying the destination path for a vector layer "`
`377`		`- "created by the algorithm. "`
`378`		`- "Consider using the more flexible QgsProcessingParameterFeatureSink "`
`379`		`- "wherever possible." );`
	`375`	`+ return QCoreApplication::translate( "Processing", "A vector layer destination parameter." );`
`380`	`376`	`}`
`381`	`377`
`382`	`378`	`virtual QString name() const override`
`@@ -420,9 +416,7 @@ class CORE_EXPORT QgsProcessingParameterTypeFileDestination : public QgsProcessi`
`420`	`416`
`421`	`417`	`virtual QString description() const override`
`422`	`418`	`{`
`423`		`- return QCoreApplication::translate( "Processing", "A generic file based destination parameter, "`
`424`		`- "for specifying the destination path for a file (non-map layer) "`
`425`		`- "created by the algorithm.." );`
	`419`	`+ return QCoreApplication::translate( "Processing", "A generic file based destination parameter." );`
`426`	`420`	`}`
`427`	`421`
`428`	`422`	`virtual QString name() const override`
`@@ -467,9 +461,7 @@ class CORE_EXPORT QgsProcessingParameterTypeFolderDestination : public QgsProces`
`467`	`461`
`468`	`462`	`virtual QString description() const override`
`469`	`463`	`{`
`470`		`- return QCoreApplication::translate( "Processing", "A folder destination parameter, "`
`471`		`- "for specifying the destination path for a folder created "`
`472`		`- "by the algorithm or used for creating new files within the algorithm." );`
	`464`	`+ return QCoreApplication::translate( "Processing", "A folder destination parameter." );`
`473`	`465`	`}`
`474`	`466`
`475`	`467`	`virtual QString name() const override`
`@@ -513,9 +505,7 @@ class CORE_EXPORT QgsProcessingParameterTypeRasterDestination : public QgsProces`
`513`	`505`
`514`	`506`	`virtual QString description() const override`
`515`	`507`	`{`
`516`		`- return QCoreApplication::translate( "Processing", "A raster layer destination parameter, "`
`517`		`- "for specifying the destination path for a raster layer "`
`518`		`- "created by the algorithm." );`
	`508`	`+ return QCoreApplication::translate( "Processing", "A raster layer destination parameter." );`
`519`	`509`	`}`
`520`	`510`
`521`	`511`	`virtual QString name() const override`
`@@ -593,7 +583,7 @@ class CORE_EXPORT QgsProcessingParameterTypeMultipleLayers : public QgsProcessin`
`593`	`583`
`594`	`584`	`virtual QString name() const override`
`595`	`585`	`{`
`596`		`- return QCoreApplication::translate( "Processing", "Multiple Layers" );`
	`586`	`+ return QCoreApplication::translate( "Processing", "Multiple Input" );`
`597`	`587`	`}`
`598`	`588`
`599`	`589`	`virtual QString id() const override`
`@@ -618,16 +608,12 @@ class CORE_EXPORT QgsProcessingParameterTypeFeatureSource : public QgsProcessing`
`618`	`608`
`619`	`609`	`virtual QString description() const override`
`620`	`610`	`{`
`621`		`- return QCoreApplication::translate( "Processing", "An input feature source (such as vector layers) "`
`622`		`- "parameter for processing algorithms. "`
`623`		`- "This is the preferred way to pass features into an algorithm. "`
`624`		`- "It can be directly connected to outputs (feature sinks) from "`
`625`		`- "other algorithms and does not necessarily require an intermediate layer." );`
	`611`	`+ return QCoreApplication::translate( "Processing", "A vector feature parameter, e.g. for algorithms which operate on the features within a layer." );`
`626`	`612`	`}`
`627`	`613`
`628`	`614`	`virtual QString name() const override`
`629`	`615`	`{`
`630`		`- return QCoreApplication::translate( "Processing", "Feature Source" );`
	`616`	`+ return QCoreApplication::translate( "Processing", "Vector Features" );`
`631`	`617`	`}`
`632`	`618`
`633`	`619`	`virtual QString id() const override`