Skip to content

Commit 57b7692

Browse files
committed
Expand docs
1 parent 21f92a6 commit 57b7692

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

python/core/processing/qgsprocessingutils.sip

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,12 @@ class QgsProcessingUtils
199199

200200
Duplicate field names will be altered to "name_2", "name_3", etc, finding the first
201201
non-duplicate name.
202+
203+
.. note::
204+
205+
Some output file formats (e.g. shapefiles) have restrictions on the maximum
206+
length of field names, so be aware that the results of calling this method may
207+
be truncated when saving to these formats.
202208
:rtype: QgsFields
203209
%End
204210

src/core/processing/qgsprocessingutils.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,10 @@ class CORE_EXPORT QgsProcessingUtils
229229
*
230230
* Duplicate field names will be altered to "name_2", "name_3", etc, finding the first
231231
* non-duplicate name.
232+
*
233+
* \note Some output file formats (e.g. shapefiles) have restrictions on the maximum
234+
* length of field names, so be aware that the results of calling this method may
235+
* be truncated when saving to these formats.
232236
*/
233237
static QgsFields combineFields( const QgsFields &fieldsA, const QgsFields &fieldsB );
234238

0 commit comments

Comments
 (0)