Skip to content
Permalink
Browse files

Sipify

  • Loading branch information
nyalldawson committed Feb 26, 2019
1 parent b1b247b commit b6d66becab6fe8025be41e347c0448495bb42319
Showing 360 changed files with 1,430 additions and 1,430 deletions.
@@ -110,14 +110,14 @@ A human readable description for this rule
%Docstring
Returns if this rule is active

:return: True if the rule is active
:return: ``True`` if the rule is active
%End

bool isElse() const;
%Docstring
Check if this rule is an ELSE rule

:return: True if this rule is an else rule
:return: ``True`` if this rule is an else rule
%End

QString ruleKey() const;
@@ -155,7 +155,7 @@ Sets if this rule is active
%Docstring
Sets if this rule is an ELSE rule

:param iselse: If true, this rule is an ELSE rule
:param iselse: If ``True``, this rule is an ELSE rule
%End

void setRuleKey( const QString &key );
@@ -129,7 +129,7 @@ Method to be overridden for progress reporting.

:param complete: Overall progress of the alignment operation

:return: false if the execution should be canceled, true otherwise
:return: ``False`` if the execution should be canceled, ``True`` otherwise
%End

virtual ~ProgressHandler();
@@ -206,7 +206,7 @@ If default CRS is used, the parameters are set according to the raster file's ge
If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order
to determine suitable defaults for cell size and grid offset.

:return: true on success (may fail if it is not possible to reproject raster to given CRS)
:return: ``True`` on success (may fail if it is not possible to reproject raster to given CRS)
%End

bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
@@ -219,7 +219,7 @@ See the other variant for details.
%Docstring
Determine destination extent from the input rasters and calculate derived values

:return: true on success, sets error on error (see errorMessage())
:return: ``True`` on success, sets error on error (see errorMessage())
%End

QSize alignedRasterSize() const;
@@ -244,13 +244,13 @@ Returns the expected extent of the resulting aligned raster
%Docstring
Run the alignment process

:return: true on success, sets error on error (see errorMessage())
:return: ``True`` on success, sets error on error (see errorMessage())
%End

QString errorMessage() const;
%Docstring
Returns the error from a previous run() call.
Error message is empty if run() succeeded (returned true)
Error message is empty if run() succeeded (returned ``True``)
%End

void dump() const;
@@ -272,7 +272,7 @@ Internal function for processing of one raster (1. create output, 2. do the alig

static bool suggestedWarpOutput( const RasterInfo &info, const QString &destWkt, QSizeF *cellSize = 0, QPointF *gridOffset = 0, QgsRectangle *rect = 0 );
%Docstring
Determine suggested output of raster warp to a different CRS. Returns true on success
Determine suggested output of raster warp to a different CRS. Returns ``True`` on success
%End

protected:
@@ -26,7 +26,7 @@ Contains utilities for working with EXIF tags in images.
%Docstring
Returns the geotagged coordinate stored in the image at ``imagePath``.

If a geotag was found, ``ok`` will be set to true.
If a geotag was found, ``ok`` will be set to ``True``.

If the image contains an elevation tag then the returned point will contain
the elevation as a z value.
@@ -60,7 +60,7 @@ The ``location`` argument indicates the GPS location to write to the image, as a

If desired, extended GPS tags (such as elevation) can be specified via the ``details`` argument.

Returns true if writing was successful.
Returns ``True`` if writing was successful.

.. seealso:: :py:func:`getGeoTag`
%End
@@ -78,7 +78,7 @@ QgsRasterCalcNode cannot be copied
%Docstring
Returns a string representation of the expression

:param cStyle: if true operators will follow C syntax
:param cStyle: if ``True`` operators will follow C syntax

.. versionadded:: 3.6
%End
@@ -58,7 +58,7 @@ Takes ownership of data array

bool isNumber() const;
%Docstring
Returns true if matrix is 1x1 (=scalar number)
Returns ``True`` if matrix is 1x1 (=scalar number)
%End
double number() const;

@@ -38,7 +38,7 @@ Creates a new feature pool for ``layer``.
%Docstring
Retrieves the feature with the specified ``id`` into ``feature``.
It will be retrieved from the cache or from the underlying layer if unavailable.
If the feature is neither available from the cache nor from the layer it will return false.
If the feature is neither available from the cache nor from the layer it will return ``False``.
If ``feedback`` is specified, the call may return if the feedback is canceled.
%End

@@ -152,7 +152,7 @@ of base information is done in parent class.
virtual bool closeMatch( QgsGeometryCheckError * /*other*/ ) const;
%Docstring
Check if this error is almost equal to ``other``.
If this returns true, it can be used to update existing errors after re-checking.
If this returns ``True``, it can be used to update existing errors after re-checking.
%End

virtual void update( const QgsGeometryCheckError *other );
@@ -47,7 +47,7 @@ a set of layers.
%Docstring
Create a new layer/feature combination.
The layer is defined by ``pool``, ``feature`` needs to be from this layer.
If ``useMapCrs`` is True, geometries will be reprojected to the mapCrs defined
If ``useMapCrs`` is ``True``, geometries will be reprojected to the mapCrs defined
in ``context``.
%End

@@ -57,7 +57,7 @@ reflecting the annotation's current state.

bool isVisible() const;
%Docstring
Returns true if the annotation is visible and should be rendered.
Returns ``True`` if the annotation is visible and should be rendered.

.. seealso:: :py:func:`setVisible`
%End
@@ -71,8 +71,8 @@ Sets whether the annotation is visible and should be rendered.

bool hasFixedMapPosition() const;
%Docstring
Returns true if the annotation is attached to a fixed map position, or
false if the annotation uses a position relative to the current map
Returns ``True`` if the annotation is attached to a fixed map position, or
``False`` if the annotation uses a position relative to the current map
extent.

.. seealso:: :py:func:`setHasFixedMapPosition`
@@ -42,7 +42,7 @@ manager.
bool addAnnotation( QgsAnnotation *annotation /Transfer/ );
%Docstring
Adds an annotation to the manager. Ownership of the annotation is transferred to the manager.
Returns true if the addition was successful, or false if the annotation could not be added.
Returns ``True`` if the addition was successful, or ``False`` if the annotation could not be added.

.. seealso:: :py:func:`removeAnnotation`

@@ -52,7 +52,7 @@ Returns true if the addition was successful, or false if the annotation could no
bool removeAnnotation( QgsAnnotation *annotation );
%Docstring
Removes an annotation from the manager. The annotation is deleted.
Returns true if the removal was successful, or false if the removal failed (eg as a result
Returns ``True`` if the removal was successful, or ``False`` if the removal failed (eg as a result
of removing an annotation which is not contained in the manager).

.. seealso:: :py:func:`addAnnotation`
@@ -161,7 +161,7 @@ Determine if the PEM-encoded text of a key is PKCS#8 format

:param keyPemTxt: PEM-encoded text

:return: True if PKCS#8, otherwise false
:return: ``True`` if PKCS#8, otherwise ``False``
%End


@@ -307,7 +307,7 @@ certIsViable checks for viability errors of ``cert`` and whether it is NULL

:param cert: certificate to be checked

:return: false if cert is NULL or has viability errors
:return: ``False`` if cert is NULL or has viability errors
%End

static QList<QSslError> validateCertChain( const QList<QSslCertificate> &certificateChain,
@@ -318,7 +318,7 @@ validateCertChain validates the given ``certificateChain``

:param certificateChain: list of certificates to be checked, with leaf first and with optional root CA last
:param hostName: (optional) name of the host to be verified
:param trustRootCa: if true the CA will be added to the trusted CAs for this validation check
:param trustRootCa: if ``True`` the CA will be added to the trusted CAs for this validation check

:return: list of QSslError, if the list is empty then the cert chain is valid
%End
@@ -329,9 +329,9 @@ validatePKIBundle validate the PKI bundle by checking the certificate chain, the
expiration and effective dates, optionally trusts the root CA

:param bundle:
:param useIntermediates: if true the intermediate certs are also checked
:param trustRootCa: if true the CA will be added to the trusted CAs for this validation check (if useIntermediates is false)
this option is ignored and set to false
:param useIntermediates: if ``True`` the intermediate certs are also checked
:param trustRootCa: if ``True`` the CA will be added to the trusted CAs for this validation check (if useIntermediates is ``False``)
this option is ignored and set to ``False``

:return: a list of error strings, if the list is empty then the PKI bundle is valid
%End
@@ -42,7 +42,7 @@ init initialize QCA, prioritize qca-ossl plugin and optionally set up the authen
:param pluginPath: the plugin path
:param authDatabasePath: the authentication DB path

:return: true on success
:return: ``True`` on success

.. seealso:: :py:func:`QgsApplication.pluginPath`

@@ -167,8 +167,8 @@ Re-emit a signal to schedule an optional erase of authentication database.
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.
: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.
%End

QString authManTag() const;
@@ -130,7 +130,7 @@ Returns whether the effect will convert a picture to grayscale.
%Docstring
Sets whether the effect should colorize a picture.

:param colorizeOn: set to true to enable colorization
:param colorizeOn: set to ``True`` to enable colorization

.. seealso:: :py:func:`colorizeOn`

@@ -143,7 +143,7 @@ Sets whether the effect should colorize a picture.
%Docstring
Returns whether the effect will colorize a picture.

:return: true if colorization is enabled
:return: ``True`` if colorization is enabled

.. seealso:: :py:func:`setColorizeOn`

@@ -155,7 +155,7 @@ Returns whether the effect will colorize a picture.
void setColorizeColor( const QColor &colorizeColor );
%Docstring
Sets the color used for colorizing a picture. This is only used if
setColorizeOn() is set to true.
setColorizeOn() is set to ``True``.

:param colorizeColor: colorization color

@@ -169,7 +169,7 @@ setColorizeOn() is set to true.
QColor colorizeColor() const;
%Docstring
Returns the color used for colorizing a picture. This is only used if
colorizeOn() is set to true.
colorizeOn() is set to ``True``.

:return: colorization color

@@ -183,7 +183,7 @@ colorizeOn() is set to true.
void setColorizeStrength( int colorizeStrength );
%Docstring
Sets the strength for colorizing a picture. This is only used if
setColorizeOn() is set to true.
setColorizeOn() is set to ``True``.

:param colorizeStrength: colorization strength, between 0 and 100

@@ -197,7 +197,7 @@ setColorizeOn() is set to true.
int colorizeStrength() const;
%Docstring
Returns the strength used for colorizing a picture. This is only used if
setColorizeOn() is set to true.
setColorizeOn() is set to ``True``.

:return: colorization strength, between 0 and 100

@@ -271,7 +271,7 @@ color ramp or by specificing a single color.
Specifies whether the glow is drawn outside the picture or within
the picture.

:return: true if glow is to be drawn outside the picture, or false
:return: ``True`` if glow is to be drawn outside the picture, or ``False``
to draw glow within the picture
%End

@@ -125,12 +125,12 @@ speed and blur quality.

:param image: QImage to blur
:param radius: blur radius in pixels, maximum value of 16
:param alphaOnly: set to true to blur only the alpha component of the image
:param alphaOnly: set to ``True`` to blur only the alpha component of the image

.. 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, int radius ) /Factory/;
@@ -164,7 +164,7 @@ Calculates the non-transparent region of an image.
:param minSize: minimum size for returned region, if desired. If the
non-transparent region of the image is smaller than this minimum size,
it will be centered in the returned rectangle.
:param center: return rectangle will be centered on the center of the original image if set to true
:param center: return rectangle will be centered on the center of the original image if set to ``True``

.. seealso:: :py:func:`cropTransparent`

@@ -179,7 +179,7 @@ Crop any transparent border from around an image.
:param minSize: minimum size for cropped image, if desired. If the
cropped image is smaller than the minimum size, it will be centered
in the returned image.
:param center: cropped image will be centered on the center of the original image if set to true
:param center: cropped image will be centered on the center of the original image if set to ``True``

.. versionadded:: 2.9
%End
@@ -138,7 +138,7 @@ properties().
:param doc: destination DOM document
:param element: destination DOM element

:return: true if save was successful
:return: ``True`` if save was successful

.. seealso:: :py:func:`readProperties`
%End
@@ -149,7 +149,7 @@ Restores the effect to the state described by a DOM element.

:param element: DOM element describing an effect's state

:return: true if read was successful
:return: ``True`` if read was successful

.. seealso:: :py:func:`saveProperties`
%End
@@ -191,7 +191,7 @@ to the render context after being modified by the effect.
%Docstring
Returns whether the effect is enabled

:return: true if effect is enabled
:return: ``True`` if effect is enabled

.. seealso:: :py:func:`setEnabled`
%End
@@ -200,7 +200,7 @@ Returns whether the effect is enabled
%Docstring
Sets whether the effect is enabled

:param enabled: set to false to disable the effect
:param enabled: set to ``False`` to disable the effect

.. seealso:: :py:func:`enabled`
%End
@@ -116,7 +116,7 @@ Registers a new effect type.

:param metadata: effect metadata. Ownership is transferred to the registry.

:return: true if add was successful.
:return: ``True`` if add was successful.
%End

QgsPaintEffect *createEffect( const QString &name, const QgsStringMap &properties = QgsStringMap() ) const /Factory/;
@@ -165,7 +165,7 @@ Tests whether a paint effect matches the default effects stack.

:param effect: paint effect to test

:return: true if effect is default stack
:return: ``True`` if effect is default stack

.. seealso:: :py:func:`defaultStack`

@@ -219,7 +219,7 @@ Returns the blend mode for the effect
Specifies whether the shadow is drawn outside the picture or within
the picture.

:return: true if shadow is to be drawn outside the picture, or false
:return: ``True`` if shadow is to be drawn outside the picture, or ``False``
to draw shadow within the picture
%End

0 comments on commit b6d66be

Please sign in to comment.
You can’t perform that action at this time.