Added note in the documentation about the new behavior

qgis · Mar 25, 2019 · eb3e18d · eb3e18d
1 parent 7c8f584
commit eb3e18d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/python/core/auto_generated/qgsmaplayerstore.sip.in b/python/core/auto_generated/qgsmaplayerstore.sip.in
@@ -120,6 +120,13 @@ The layersAdded() and layerWasAdded() signals will always be emitted.
 
 :param layers: A list of layer which should be added to the store.
 
+.. note::
+
+   if layer with the same id is already in the store it is not added again,
+   but if the validity of the layer has changed from false to true, the
+   layer data source is updated to the new one.
+
+
 :return: a list of the map layers that were added
          successfully. If a layer already exists in the store,
          it will not be part of the returned list.

diff --git a/src/core/qgsmaplayerstore.h b/src/core/qgsmaplayerstore.h
@@ -149,6 +149,11 @@ class CORE_EXPORT QgsMapLayerStore : public QObject
      *                      If you specify FALSE here you have take care of deleting
      *                      the layers yourself. Not available in Python.
      *
+     *
+     * \note if layer with the same id is already in the store it is not added again,
+     *       but if the validity of the layer has changed from false to true, the
+     *       layer data source is updated to the new one.
+     *
      * \returns a list of the map layers that were added
      *         successfully. If a layer already exists in the store,
      *         it will not be part of the returned list.