Expand docs

qgis · Sep 22, 2017 · 57b76920d6e9a5c4e46696c993d9eb05c5e2da54 · 57b7692
1 parent 21f92a6
commit 57b76920d6e9a5c4e46696c993d9eb05c5e2da54
Unified Split

Showing with 10 additions and 0 deletions.

+6 −0 python/core/processing/qgsprocessingutils.sip

+4 −0 src/core/processing/qgsprocessingutils.h
diff --git a/python/core/processing/qgsprocessingutils.sip b/python/core/processing/qgsprocessingutils.sip
@@ -199,6 +199,12 @@ class QgsProcessingUtils
 
  Duplicate field names will be altered to "name_2", "name_3", etc, finding the first
  non-duplicate name.
+
+.. note::
+
+   Some output file formats (e.g. shapefiles) have restrictions on the maximum
+ length of field names, so be aware that the results of calling this method may
+ be truncated when saving to these formats.
  :rtype: QgsFields
 %End
 

diff --git a/src/core/processing/qgsprocessingutils.h b/src/core/processing/qgsprocessingutils.h
@@ -229,6 +229,10 @@ class CORE_EXPORT QgsProcessingUtils
      *
      * Duplicate field names will be altered to "name_2", "name_3", etc, finding the first
      * non-duplicate name.
+     *
+     * \note Some output file formats (e.g. shapefiles) have restrictions on the maximum
+     * length of field names, so be aware that the results of calling this method may
+     * be truncated when saving to these formats.
      */
     static QgsFields combineFields( const QgsFields &fieldsA, const QgsFields &fieldsB );