run sipify

qgis · Jan 13, 2018 · 6d94ac9 · 6d94ac9
1 parent ba95189
commit 6d94ac9
Show file tree

Hide file tree

Showing 69 changed files with 259 additions and 259 deletions.
diff --git a/python/core/auth/qgsauthmanager.sip b/python/core/auth/qgsauthmanager.sip
@@ -161,8 +161,8 @@ Re-emit a signal to schedule an optional erase of authentication database.
 .. note::
 
    This can be called from the slot connected to a previously emitted scheduling signal,
-so that the slot can ask for another emit later, if the slot noticies the current GUI
-processing state is not ready for interacting with the user, e.g. project is still loading
+   so that the slot can ask for another emit later, if the slot noticies the current GUI
+   processing state is not ready for interacting with the user, e.g. project is still loading
 
 :param emitted: Setting to false will cause signal to be emitted by the schedule timer.
 Setting to true will stop any emitting, but will not stop the schedule timer.

diff --git a/python/core/auth/qgsauthmethod.sip b/python/core/auth/qgsauthmethod.sip
@@ -129,8 +129,8 @@ Clear any cached configuration. Called when the QgsAuthManager deletes an authen
 .. note::
 
    It is highly recommended that a cache of authentication components (per requested authcfg)
-be implemented, to avoid excessive queries on the auth database. Such a cache could be as
-simple as a QHash or QMap of authcfg -> QgsAuthMethodConfig. See 'Basic' auth method plugin for example.
+   be implemented, to avoid excessive queries on the auth database. Such a cache could be as
+   simple as a QHash or QMap of authcfg -> QgsAuthMethodConfig. See 'Basic' auth method plugin for example.
 %End
 
     virtual void updateMethodConfig( QgsAuthMethodConfig &mconfig ) = 0;

diff --git a/python/core/effects/qgsimageoperation.sip b/python/core/effects/qgsimageoperation.sip
@@ -130,7 +130,7 @@ speed and blur quality.
 .. note::
 
    for fastest operation, ensure the source image is ARGB32_Premultiplied if
-alphaOnly is set to false, or ARGB32 if alphaOnly is true
+   alphaOnly is set to false, or ARGB32 if alphaOnly is true
 %End
 
     static QImage *gaussianBlur( QImage &image, const int radius ) /Factory/;

diff --git a/python/core/effects/qgspainteffectregistry.sip b/python/core/effects/qgspainteffectregistry.sip
@@ -18,8 +18,8 @@ class QgsPaintEffectAbstractMetadata
 .. note::
 
    It's necessary to implement the createPaintEffect() function.
-In C++ you can use the QgsPaintEffectMetadata convenience class to
-simplify creation of the metadata.
+   In C++ you can use the QgsPaintEffectMetadata convenience class to
+   simplify creation of the metadata.
 
 .. versionadded:: 2.9
 %End

diff --git a/python/core/expression/qgsexpression.sip b/python/core/expression/qgsexpression.sip
@@ -132,8 +132,8 @@ Get list of columns referenced by the expression.
 .. note::
 
    If the returned list contains the QgsFeatureRequest.AllAttributes constant then
-all attributes from the layer are required for evaluation of the expression.
-QgsFeatureRequest.setSubsetOfAttributes automatically handles this case.
+   all attributes from the layer are required for evaluation of the expression.
+   QgsFeatureRequest.setSubsetOfAttributes automatically handles this case.
 
 .. seealso:: :py:func:`referencedAttributeIndexes`
 %End
@@ -355,7 +355,7 @@ value.
 .. note::
 
    this method is inefficient for bulk evaluation of expressions, it is intended
-for one-off evaluations only.
+   for one-off evaluations only.
 %End
 
     enum SpatialOperator

diff --git a/python/core/geocms/geonode/qgsgeonoderequest.sip b/python/core/geocms/geonode/qgsgeonoderequest.sip
@@ -70,8 +70,8 @@ Calling this method does not block while waiting for a result.
 .. warning::
 
    When using the non-blocking methods in this class, sending
-overlapping requests results in undefined behavior. Use separate instances
-of QgsGeoNodeRequest instead to avoid this.
+   overlapping requests results in undefined behavior. Use separate instances
+   of QgsGeoNodeRequest instead to avoid this.
 
 .. seealso:: :py:func:`requestBlocking`
 %End
@@ -98,8 +98,8 @@ This method is non-blocking and returns immediately.
 .. warning::
 
    When using the non-blocking methods in this class, sending
-overlapping requests results in undefined behavior. Use separate instances
-of QgsGeoNodeRequest instead to avoid this.
+   overlapping requests results in undefined behavior. Use separate instances
+   of QgsGeoNodeRequest instead to avoid this.
 
 .. seealso:: :py:func:`layersFetched`
 

diff --git a/python/core/geometry/qgsgeometry.sip b/python/core/geometry/qgsgeometry.sip
@@ -305,7 +305,7 @@ Uses GEOS library for the test.
 .. note::
 
    This is useful mainly for linestrings and linear rings. Polygons are simple by definition,
-for checking anomalies in polygon geometries one can use isGeosValid().
+   for checking anomalies in polygon geometries one can use isGeosValid().
 
 .. versionadded:: 3.0
 %End
@@ -939,7 +939,7 @@ by calling `error()` on the returned geometry.
 .. note::
 
    for line based geometries, the center point of the line is returned,
-and for point based geometries, the point itself is returned
+   and for point based geometries, the point itself is returned
 
 .. seealso:: :py:func:`pointOnSurface`
 
@@ -1368,7 +1368,7 @@ The ``method`` argument dictates which validator to utilize.
 .. note::
 
    Available in Python bindings since QGIS 1.6
-*
+   *
 %End
 
     static QgsGeometry unaryUnion( const QVector<QgsGeometry> &geometries );

diff --git a/python/core/geometry/qgspoint.sip b/python/core/geometry/qgspoint.sip
@@ -155,7 +155,7 @@ Sets the point's z-coordinate.
 .. note::
 
    calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to
-add a z value and force the point to have a z dimension.
+   add a z value and force the point to have a z dimension.
 
 .. seealso:: z
 
@@ -169,7 +169,7 @@ Sets the point's m-value.
 .. note::
 
    calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to
-add a m value and force the point to have an m dimension.
+   add a m value and force the point to have an m dimension.
 
 .. seealso:: m
 

diff --git a/python/core/layout/qgsabstractreportsection.sip b/python/core/layout/qgsabstractreportsection.sip
@@ -18,7 +18,7 @@ class QgsReportSectionContext
 .. warning::
 
    This is not considered stable API, and may change in future QGIS releases. It is
-exposed to the Python bindings for unit testing purposes only.
+   exposed to the Python bindings for unit testing purposes only.
 
 .. versionadded:: 3.0
 %End
@@ -42,7 +42,7 @@ class QgsAbstractReportSection : QgsAbstractLayoutIterator
 .. warning::
 
    This is not considered stable API, and may change in future QGIS releases. It is
-exposed to the Python bindings for unit testing purposes only.
+   exposed to the Python bindings for unit testing purposes only.
 
 .. versionadded:: 3.0
 %End

diff --git a/python/core/layout/qgslayoutatlas.sip b/python/core/layout/qgslayoutatlas.sip
@@ -18,8 +18,8 @@ This class is used for printing, exporting to PDF and images.
 .. note::
 
    This class should not be created directly. For the atlas to function correctly
-the atlasComposition() property for QgsComposition should be used to retrieve a
-QgsLayoutAtlas which is automatically created and attached to the composition.
+   the atlasComposition() property for QgsComposition should be used to retrieve a
+   QgsLayoutAtlas which is automatically created and attached to the composition.
 
 .. versionadded:: 3.0
 %End

diff --git a/python/core/layout/qgslayoutguidecollection.sip b/python/core/layout/qgslayoutguidecollection.sip
@@ -47,7 +47,7 @@ Sets the ``layout`` the guide belongs to.
 .. note::
 
    Adding the guide to a QgsLayoutGuideCollection will automatically set
-the corresponding layout for you.
+   the corresponding layout for you.
 
 .. seealso:: :py:func:`layout`
 %End

diff --git a/python/core/layout/qgslayoutitem.sip b/python/core/layout/qgslayoutitem.sip
@@ -273,8 +273,8 @@ Sets whether the item is ``visible``.
 .. note::
 
    QGraphicsItem.setVisible should not be called directly
-on a QgsLayoutItem, as some item types (e.g., groups) need to override
-the visibility toggle.
+   on a QgsLayoutItem, as some item types (e.g., groups) need to override
+   the visibility toggle.
 %End
 
     void setLocked( const bool locked );

diff --git a/python/core/layout/qgslayoutitemmapgrid.sip b/python/core/layout/qgslayoutitemmapgrid.sip
@@ -41,7 +41,7 @@ above any existing map grids already present in the stack.
 .. note::
 
    After adding a grid to the stack, updateBoundingRect() and update()
-should be called for the QgsLayoutItemMap to prevent rendering artifacts.
+   should be called for the QgsLayoutItemMap to prevent rendering artifacts.
 
 .. seealso:: :py:func:`removeGrid`
 %End
@@ -53,7 +53,7 @@ Removes a grid with matching ``gridId`` from the stack and deletes the correspon
 .. note::
 
    After removing a grid from the stack, updateBoundingRect() and update()
-should be called for the QgsLayoutItemMap to prevent rendering artifacts.
+   should be called for the QgsLayoutItemMap to prevent rendering artifacts.
 
 .. seealso:: :py:func:`addGrid`
 %End
@@ -65,7 +65,7 @@ Moves a grid with matching ``gridId`` up the stack, causing it to be rendered ab
 .. note::
 
    After moving a grid within the stack, update() should be
-called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
+   called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
 
 .. seealso:: :py:func:`moveGridDown`
 %End
@@ -77,7 +77,7 @@ Moves a grid with matching ``gridId`` down the stack, causing it to be rendered
 .. note::
 
    After moving a grid within the stack, update() should be
-called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
+   called for the QgsLayoutItemMap to redraw the map with the new grid stack order.
 
 .. seealso:: :py:func:`moveGridUp`
 %End

diff --git a/python/core/layout/qgslayoutitemmapitem.sip b/python/core/layout/qgslayoutitemmapitem.sip
@@ -180,7 +180,7 @@ above any existing map items already present in the stack.
 .. note::
 
    After adding an item to the stack update()
-should be called for the QgsLayoutItemMap to prevent rendering artifacts.
+   should be called for the QgsLayoutItemMap to prevent rendering artifacts.
 
 .. seealso:: :py:func:`removeItem`
 %End
@@ -192,7 +192,7 @@ Removes an item which matching ``itemId`` from the stack and deletes the corresp
 .. note::
 
    After removing an item from the stack, update()
-should be called for the QgsLayoutItemMap to prevent rendering artifacts.
+   should be called for the QgsLayoutItemMap to prevent rendering artifacts.
 
 .. seealso:: :py:func:`addItem`
 %End
@@ -204,7 +204,7 @@ Moves an item which matching ``itemId`` up the stack, causing it to be rendered
 .. note::
 
    After moving an item within the stack, update() should be
-called for the QgsLayoutItemMap to redraw the map with the new item stack order.
+   called for the QgsLayoutItemMap to redraw the map with the new item stack order.
 
 .. seealso:: :py:func:`moveItemDown`
 %End
@@ -216,7 +216,7 @@ Moves an item which matching ``itemId`` up the stack, causing it to be rendered
 .. note::
 
    After moving an item within the stack, update() should be
-called for the QgsLayoutItemMap to redraw the map with the new item stack order.
+   called for the QgsLayoutItemMap to redraw the map with the new item stack order.
 
 .. seealso:: :py:func:`moveItemUp`
 %End

diff --git a/python/core/layout/qgslayoutitemmapoverview.sip b/python/core/layout/qgslayoutitemmapoverview.sip
@@ -42,7 +42,7 @@ above any existing map overviews already present in the stack.
 .. note::
 
    After adding a overview to the stack, update()
-should be called for the QgsLayoutItemMap to prevent rendering artifacts.
+   should be called for the QgsLayoutItemMap to prevent rendering artifacts.
 
 .. seealso:: :py:func:`removeOverview`
 %End
@@ -54,7 +54,7 @@ Removes an overview with matching overviewId from the stack and deletes the corr
 .. note::
 
    After removing an overview from the stack, update()
-should be called for the QgsLayoutItemMap to prevent rendering artifacts.
+   should be called for the QgsLayoutItemMap to prevent rendering artifacts.
 
 .. seealso:: :py:func:`addOverview`
 %End
@@ -66,7 +66,7 @@ Moves an overview with matching overviewId up the stack, causing it to be render
 .. note::
 
    After moving an overview within the stack, update() should be
-called for the QgsLayoutItemMap to redraw the map with the new overview stack order.
+   called for the QgsLayoutItemMap to redraw the map with the new overview stack order.
 
 .. seealso:: :py:func:`moveOverviewDown`
 %End
@@ -78,7 +78,7 @@ Moves an overview with matching overviewId down the stack, causing it to be rend
 .. note::
 
    After moving an overview within the stack, update() should be
-called for the QgsLayoutItemMap to redraw the map with the new overview stack order.
+   called for the QgsLayoutItemMap to redraw the map with the new overview stack order.
 
 .. seealso:: :py:func:`moveOverviewUp`
 %End

diff --git a/python/core/layout/qgslayoutitempicture.sip b/python/core/layout/qgslayoutitempicture.sip
@@ -191,7 +191,7 @@ Sets the fill ``color`` used for parametrized SVG files.
 .. note::
 
    This setting only has an effect on parametrized SVG files, and is ignored for
-non-parametrized SVG files.
+   non-parametrized SVG files.
 
 .. seealso:: :py:func:`svgFillColor`
 
@@ -216,7 +216,7 @@ Sets the stroke ``color`` used for parametrized SVG files.
 .. note::
 
    This setting only has an effect on parametrized SVG files, and is ignored for
-non-parametrized SVG files.
+   non-parametrized SVG files.
 
 .. seealso:: :py:func:`svgStrokelColor`
 
@@ -239,7 +239,7 @@ Sets the stroke ``width`` (in layout units) used for parametrized SVG files.
 .. note::
 
    This setting only has an effect on parametrized SVG files, and is ignored for
-non-parametrized SVG files.
+   non-parametrized SVG files.
 
 .. seealso:: :py:func:`svgStrokeWidth`
 

diff --git a/python/core/layout/qgslayoutitemtexttable.sip b/python/core/layout/qgslayoutitemtexttable.sip
@@ -48,8 +48,8 @@ Adds a row to the table
 .. note::
 
    If row is shorter than the number of columns in the table than blank cells
-will be inserted at the end of the row. If row contains more strings then the number
-of columns in the table then these extra strings will be ignored.
+   will be inserted at the end of the row. If row contains more strings then the number
+   of columns in the table then these extra strings will be ignored.
 
 .. note::
 

diff --git a/python/core/layout/qgslayoutobject.sip b/python/core/layout/qgslayoutobject.sip
@@ -91,8 +91,8 @@ Constructor for QgsLayoutObject, with the specified parent ``layout``.
 .. note::
 
    While ownership of a QgsLayoutObject is not passed to the layout,
-classes which are derived from QgsLayoutObject (such as QgsLayoutItem)
-may transfer their ownership to a layout upon construction.
+   classes which are derived from QgsLayoutObject (such as QgsLayoutItem)
+   may transfer their ownership to a layout upon construction.
 %End
 
 

diff --git a/python/core/layout/qgslayoutpagecollection.sip b/python/core/layout/qgslayoutpagecollection.sip
@@ -255,8 +255,8 @@ first page.
 .. note::
 
    This is a relaxed check, which will always return a page number. For instance,
-it does not consider x coordinates and vertical coordinates before the first page or
-after the last page will still return the nearest page.
+   it does not consider x coordinates and vertical coordinates before the first page or
+   after the last page will still return the nearest page.
 
 .. seealso:: :py:func:`predicatePageNumberForPoint`
 
@@ -293,7 +293,7 @@ If no page exists at ``point``, None will be returned.
 .. note::
 
    Unlike pageNumberForPoint(), this method only returns pages which
-directly intersect with the specified point.
+   directly intersect with the specified point.
 
 .. seealso:: :py:func:`pageNumberForPoint`
 %End

diff --git a/python/core/layout/qgslayoutpoint.sip b/python/core/layout/qgslayoutpoint.sip
@@ -22,10 +22,10 @@ for use in QGIS layouts. Measurement units are stored alongside the position.
 .. note::
 
    This class does not inherit from QPointF since QPointF includes methods which should not apply
-to positions with with units. For instance, the + and - operators would mislead users of this class
-to believe that addition of two QgsLayoutPoints with different unit types would automatically convert
-units. Instead, all unit conversion must be handled by a QgsLayoutMeasurementConverter so that
-conversion between paper and screen units can be correctly performed.
+   to positions with with units. For instance, the + and - operators would mislead users of this class
+   to believe that addition of two QgsLayoutPoints with different unit types would automatically convert
+   units. Instead, all unit conversion must be handled by a QgsLayoutMeasurementConverter so that
+   conversion between paper and screen units can be correctly performed.
 %End
 
 %TypeHeaderCode

diff --git a/python/core/layout/qgslayoutsize.sip b/python/core/layout/qgslayoutsize.sip
@@ -23,10 +23,10 @@ for use in QGIS layouts. Measurement units are stored alongside the size.
 .. note::
 
    This class does not inherit from QSizeF since QSizeF includes methods which should not apply to sizes
-with units. For instance, the + and - operators would mislead users of this class to believe that
-addition of two QgsLayoutSize with different unit types would automatically convert units. Instead,
-all unit conversion must be handled by a QgsLayoutMeasurementConverter so that conversion between
-paper and screen units can be correctly performed.
+   with units. For instance, the + and - operators would mislead users of this class to believe that
+   addition of two QgsLayoutSize with different unit types would automatically convert units. Instead,
+   all unit conversion must be handled by a QgsLayoutMeasurementConverter so that conversion between
+   paper and screen units can be correctly performed.
 %End
 
 %TypeHeaderCode

diff --git a/python/core/layout/qgsreport.sip b/python/core/layout/qgsreport.sip
@@ -20,7 +20,7 @@ subclasses.
 .. warning::
 
    This is not considered stable API, and may change in future QGIS releases. It is
-exposed to the Python bindings for unit testing purposes only.
+   exposed to the Python bindings for unit testing purposes only.
 
 .. versionadded:: 3.0
 %End