[needs-docs] Review the Dissolve algorithm description

DelazJ · nyalldawson · commit 0396abfd01e5 · 2018-09-28T10:20:11.000+10:00
* The current description focuses on geometries and assumes only line or vector layers can be dissolved
* Rename label to look more meaningful and closer to GDAL Dissolve's
diff --git a/src/analysis/processing/qgsalgorithmdissolve.cpp b/src/analysis/processing/qgsalgorithmdissolve.cpp
@@ -190,17 +190,17 @@ QString QgsDissolveAlgorithm::groupId() const
 void QgsDissolveAlgorithm::initAlgorithm( const QVariantMap & )
 {
   addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );
-  addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD" ), QObject::tr( "Unique ID fields" ), QVariant(),
+  addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD" ), QObject::tr( "Dissolve field(s)" ), QVariant(),
                 QStringLiteral( "INPUT" ), QgsProcessingParameterField::Any, true, true ) );
 
   addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Dissolved" ) ) );
 }
 
 QString QgsDissolveAlgorithm::shortHelpString() const
 {
-  return QObject::tr( "This algorithm takes a polygon or line vector layer and combines their geometries into new geometries. One or more attributes can "
-                      "be specified to dissolve only geometries belonging to the same class (having the same value for the specified attributes), alternatively "
-                      "all geometries can be dissolved.\n\n"
+  return QObject::tr( "This algorithm takes a vector layer and combines their features into new features. One or more attributes can "
+                      "be specified to dissolve features belonging to the same class (having the same value for the specified attributes), alternatively "
+                      "all features can be dissolved in a single one.\n\n"
                       "All output geometries will be converted to multi geometries. "
                       "In case the input is a polygon layer, common boundaries of adjacent polygons being dissolved will get erased." );
 }

Original file line number	Diff line number	Diff line change
`@@ -190,17 +190,17 @@ QString QgsDissolveAlgorithm::groupId() const`
`190`	`190`	`void QgsDissolveAlgorithm::initAlgorithm( const QVariantMap & )`
`191`	`191`	`{`
`192`	`192`	`addParameter( new QgsProcessingParameterFeatureSource( QStringLiteral( "INPUT" ), QObject::tr( "Input layer" ) ) );`
`193`		`- addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD" ), QObject::tr( "Unique ID fields" ), QVariant(),`
	`193`	`+ addParameter( new QgsProcessingParameterField( QStringLiteral( "FIELD" ), QObject::tr( "Dissolve field(s)" ), QVariant(),`
`194`	`194`	`QStringLiteral( "INPUT" ), QgsProcessingParameterField::Any, true, true ) );`
`195`	`195`
`196`	`196`	`addParameter( new QgsProcessingParameterFeatureSink( QStringLiteral( "OUTPUT" ), QObject::tr( "Dissolved" ) ) );`
`197`	`197`	`}`
`198`	`198`
`199`	`199`	`QString QgsDissolveAlgorithm::shortHelpString() const`
`200`	`200`	`{`
`201`		`- return QObject::tr( "This algorithm takes a polygon or line vector layer and combines their geometries into new geometries. One or more attributes can "`
`202`		`- "be specified to dissolve only geometries belonging to the same class (having the same value for the specified attributes), alternatively "`
`203`		`- "all geometries can be dissolved.\n\n"`
	`201`	`+ return QObject::tr( "This algorithm takes a vector layer and combines their features into new features. One or more attributes can "`
	`202`	`+ "be specified to dissolve features belonging to the same class (having the same value for the specified attributes), alternatively "`
	`203`	`+ "all features can be dissolved in a single one.\n\n"`
`204`	`204`	`"All output geometries will be converted to multi geometries. "`
`205`	`205`	`"In case the input is a polygon layer, common boundaries of adjacent polygons being dissolved will get erased." );`
`206`	`206`	`}`