Navigation Menu

Skip to content

Commit

Permalink
Fix spelling errors.
Browse files Browse the repository at this point in the history
 * cancelation -> cancellation
 * overal      -> overall
  • Loading branch information
sebastic authored and jef-n committed Feb 24, 2019
1 parent 8673fca commit 6b6a1ba
Show file tree
Hide file tree
Showing 73 changed files with 95 additions and 95 deletions.
6 changes: 3 additions & 3 deletions doc/api_break.dox
Expand Up @@ -1896,7 +1896,7 @@ QgsRasterCalculator {#qgis_api_break_3_0_QgsRasterCalculator}

- Cancelled (Result enum value) has been renamed to Canceled <!--#spellok-->
- processCalculation() now uses an optional QgsFeedback instead of QProgressDialog
for progress reports and cancelation.
for progress reports and cancellation.

QgsRasterDataProvider {#qgis_api_break_3_0_QgsRasterDataProvider}
---------------------
Expand Down Expand Up @@ -2581,15 +2581,15 @@ QgsRendererAbstractMetadata {#qgis_api_break_3_0_QgsRendererAbstractMetadata}
QgsGraphDirector {#qgis_api_break_3_0_QgsGraphDirector}
----------------

- makeGraph() now uses QgsFeedback for progress reporting and cancelation
- makeGraph() now uses QgsFeedback for progress reporting and cancellation
- buildProgress() signal was removed
- buildMessage() signal was removed

QgsVectorLayerDirector {#qgis_api_break_3_0_QgsVectorLayerDirector}
----------------------

- QgsVectorLayerDirector() constructor now expects a reference to QgsFeatureSource as the first argument
- makeGraph() now uses QgsFeedback for progress reporting and cancelation
- makeGraph() now uses QgsFeedback for progress reporting and cancellation

Processing {#qgis_api_break_3_0_Processing}
----------
Expand Down
4 changes: 2 additions & 2 deletions doc/porting_processing.dox
Expand Up @@ -74,7 +74,7 @@ Other porting notes

- Your algorithm's processAlgorithm methods should return a dict with output values. In the case of output feature sinks, the sink's ID string should be included in this dictionary.

- Since Processing algorithms can now be run in the background, it's important to implement support for cancelation in your algorithms. Whenever looping (or before/after calling lengthy operations) listen out for user cancelation via the provided feedback object. E.g.
- Since Processing algorithms can now be run in the background, it's important to implement support for cancellation in your algorithms. Whenever looping (or before/after calling lengthy operations) listen out for user cancellation via the provided feedback object. E.g.

if feedback.isCanceled():
break
Expand All @@ -93,7 +93,7 @@ object to pushInfo or reportError so that the lack of features is brought to use

- Don't write outputs using TableWriter or by directly creating a CSV file. Wherever possible use a feature sink instead so that the output is created as a proper vector layer. This allows other algorithms in a multi-step model to easily use the tabular outputs from the algorithm.

- To run another Processing algorithm as part of your algorithm, you can use processing.run(...). Make sure you pass the current context and feedback to processing.run to ensure that all temporary layer outputs are available to the executed algorithm, and that the executed algorithm can send feedback reports to the user (and correctly handle cancelation and progress reports!)
- To run another Processing algorithm as part of your algorithm, you can use processing.run(...). Make sure you pass the current context and feedback to processing.run to ensure that all temporary layer outputs are available to the executed algorithm, and that the executed algorithm can send feedback reports to the user (and correctly handle cancellation and progress reports!)

- A new API contract exists for Processing. Now, only the c++ base class (e.g. those prefixed with "Qgs"), the gui wrappers, and the methods from processing.tools are considered stable, public API. All other Processing classes and methods are considered private and may change between QGIS versions. These should not be relied on by custom algorithms.

Expand Down
Expand Up @@ -31,7 +31,7 @@ The ``extent`` and ``nCols``, ``nRows`` arguments dictate the extent and size of
%Docstring
Writes the grid file.

An optional ``feedback`` object can be set for progress reports and cancelation support
An optional ``feedback`` object can be set for progress reports and cancellation support

:return: 0 in case of success
%End
Expand Down
Expand Up @@ -82,7 +82,7 @@ Calculates interpolation value for map coordinates x, y

:param x: x-coordinate (in map units)
:param y: y-coordinate (in map units)
:param feedback: optional feedback object for progress and cancelation support
:param feedback: optional feedback object for progress and cancellation support

:return: - 0 in case of success
- result: interpolation result
Expand All @@ -96,7 +96,7 @@ Calculates interpolation value for map coordinates x, y
Caches the vertex and value data from the provider. All the vertex data
will be held in virtual memory.

An optional ``feedback`` argument may be specified to allow cancelation and
An optional ``feedback`` argument may be specified to allow cancellation and
progress reports from the cache operation.

:return: Success in case of success
Expand Down
Expand Up @@ -32,7 +32,7 @@ Interpolation in a triangular irregular network
QgsTinInterpolator( const QList<QgsInterpolator::LayerData> &inputData, TinInterpolation interpolation = Linear, QgsFeedback *feedback = 0 );
%Docstring
Constructor for QgsTinInterpolator.
The ``feedback`` object specifies an optional QgsFeedback object for progress reports and cancelation support.
The ``feedback`` object specifies an optional QgsFeedback object for progress reports and cancellation support.
Ownership of ``feedback`` is not transferred and callers must ensure that it exists for the lifetime of this object.
%End
~QgsTinInterpolator();
Expand Down
Expand Up @@ -83,7 +83,7 @@ Creates calculator with geometry mask
%Docstring
Starts the calculation, writes new dataset group to file and adds it to the mesh layer

:param feedback: The optional feedback argument for progress reporting and cancelation support
:param feedback: The optional feedback argument for progress reporting and cancellation support

:return: QgsMeshCalculator.Success in case of success
%End
Expand Down
Expand Up @@ -33,7 +33,7 @@ Constructor that takes input file, output file and output format (GDAL string)
%Docstring
Starts the calculation, reads from mInputFile and stores the result in mOutputFile

:param feedback: feedback object that receives update and that is checked for cancelation.
:param feedback: feedback object that receives update and that is checked for cancellation.

:return: 0 in case of success
%End
Expand Down
Expand Up @@ -100,7 +100,7 @@ QgsRasterCalculator constructor.
%Docstring
Starts the calculation and writes a new raster.

The optional ``feedback`` argument can be used for progress reporting and cancelation support.
The optional ``feedback`` argument can be used for progress reporting and cancellation support.

:return: QgsRasterCalculator.Success in case of success. If an error is encountered then
a description of the error can be obtained by calling lastError().
Expand Down
2 changes: 1 addition & 1 deletion python/analysis/auto_generated/raster/qgsrelief.sip.in
Expand Up @@ -36,7 +36,7 @@ Produces colored relief rasters from DEM*
%Docstring
Starts the calculation, reads from mInputFile and stores the result in mOutputFile

:param feedback: feedback object that receives update and that is checked for cancelation.
:param feedback: feedback object that receives update and that is checked for cancellation.

:return: 0 in case of success*
%End
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/locator/qgslocator.sip.in
Expand Up @@ -114,7 +114,7 @@ all filters.

void cancelWithoutBlocking();
%Docstring
Triggers cancelation of any current running query without blocking. The query may
Triggers cancellation of any current running query without blocking. The query may
take some time to cancel after calling this.

.. seealso:: :py:func:`cancel`
Expand Down Expand Up @@ -143,7 +143,7 @@ is called.
void finished();
%Docstring
Emitted when locator has finished a query, either as a result
of successful completion or early cancelation.
of successful completion or early cancellation.
%End

};
Expand Down
Expand Up @@ -43,7 +43,7 @@ from data provider and calculates triangular mesh
:param transformContext: Transform context to transform layer CRS to destination CRS
:param mapUnitsPerPixel: map units per pixel for block
:param extent: extent of block in destination CRS
:param feedback: optional raster feedback object for cancelation/preview
:param feedback: optional raster feedback object for cancellation/preview

:return: raster block with Float.64 values. None on error

Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/mesh/qgsmeshspatialindex.sip.in
Expand Up @@ -45,7 +45,7 @@ Constructor for :py:class:`QgsSpatialIndex`. Creates an empty R-tree index.
%Docstring
Constructor - creates R-tree and bulk loads faces from the specified mesh

The optional ``feedback`` object can be used to allow cancelation of bulk face loading. Ownership
The optional ``feedback`` object can be used to allow cancellation of bulk face loading. Ownership
of ``feedback`` is not transferred, and callers must take care that the lifetime of feedback exceeds
that of the spatial index construction.
%End
Expand Down
Expand Up @@ -900,7 +900,7 @@ will be added to the algorithm's output. This allows for "explode" type algorith
input feature results in multiple output features.

The provided ``feedback`` object can be used to push messages to the log and for giving feedback
to users. Note that handling of progress reports and algorithm cancelation is handled by
to users. Note that handling of progress reports and algorithm cancellation is handled by
the base class and subclasses do not need to reimplement this logic.

Algorithms can throw a QgsProcessingException if a fatal error occurred which should
Expand Down
6 changes: 3 additions & 3 deletions python/core/auto_generated/qgsfeedback.sip.in
Expand Up @@ -12,13 +12,13 @@
class QgsFeedback : QObject
{
%Docstring
Base class for feedback objects to be used for cancelation of something running in a worker thread.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
The class may be used as is or it may be subclassed for extended functionality
for a particular operation (e.g. report progress or pass some data for preview).

When cancel() is called, the internal code has two options to check for cancelation state:
When cancel() is called, the internal code has two options to check for cancellation state:
- if the worker thread uses an event loop (e.g. for network communication), the code can
make a queued connection to canceled() signal and handle the cancelation in its slot.
make a queued connection to canceled() signal and handle the cancellation in its slot.
- if the worker thread does not use an event loop, it can poll isCanceled() method regularly
to see if the operation should be canceled.

Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgsfiledownloader.sip.in
Expand Up @@ -77,7 +77,7 @@ Emitted when data are ready to be processed

void cancelDownload();
%Docstring
Call to abort the download and delete this object after the cancelation
Call to abort the download and delete this object after the cancellation
has been processed.

.. seealso:: :py:func:`downloadCanceled`
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgshistogram.sip.in
Expand Up @@ -47,7 +47,7 @@ result of an expression.

:param layer: vector layer
:param fieldOrExpression: field name or expression to be evaluated
:param feedback: optional feedback object to allow cancelation of calculation
:param feedback: optional feedback object to allow cancellation of calculation

:return: true if values were successfully set
%End
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgsmaprendererjob.sip.in
Expand Up @@ -61,7 +61,7 @@ Does nothing if the rendering is not active.

virtual void cancelWithoutBlocking() = 0;
%Docstring
Triggers cancelation of the rendering job without blocking. The render job will continue
Triggers cancellation of the rendering job without blocking. The render job will continue
to operate until it is able to cancel, at which stage the finished() signal will be emitted.
Does nothing if the rendering is not active.
%End
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/qgsspatialindex.sip.in
Expand Up @@ -56,7 +56,7 @@ Constructor for QgsSpatialIndex. Creates an empty R-tree index.
Constructor - creates R-tree and bulk loads it with features from the iterator.
This is much faster approach than creating an empty index and then inserting features one by one.

The optional ``feedback`` object can be used to allow cancelation of bulk feature loading. Ownership
The optional ``feedback`` object can be used to allow cancellation of bulk feature loading. Ownership
of ``feedback`` is not transferred, and callers must take care that the lifetime of feedback exceeds
that of the spatial index construction.

Expand All @@ -68,7 +68,7 @@ that of the spatial index construction.
Constructor - creates R-tree and bulk loads it with features from the source.
This is much faster approach than creating an empty index and then inserting features one by one.

The optional ``feedback`` object can be used to allow cancelation of bulk feature loading. Ownership
The optional ``feedback`` object can be used to allow cancellation of bulk feature loading. Ownership
of ``feedback`` is not transferred, and callers must take care that the lifetime of feedback exceeds
that of the spatial index construction.

Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/qgsspatialindexkdbush.sip.in
Expand Up @@ -40,7 +40,7 @@ QgsSpatialIndexKDBush objects are implicitly shared and can be inexpensively cop
%Docstring
Constructor - creates KDBush index and bulk loads it with features from the iterator.

The optional ``feedback`` object can be used to allow cancelation of bulk feature loading. Ownership
The optional ``feedback`` object can be used to allow cancellation of bulk feature loading. Ownership
of ``feedback`` is not transferred, and callers must take care that the lifetime of feedback exceeds
that of the spatial index construction.

Expand All @@ -51,7 +51,7 @@ Any non-single point features encountered during iteration will be ignored and n
%Docstring
Constructor - creates KDBush index and bulk loads it with features from the source.

The optional ``feedback`` object can be used to allow cancelation of bulk feature loading. Ownership
The optional ``feedback`` object can be used to allow cancellation of bulk feature loading. Ownership
of ``feedback`` is not transferred, and callers must take care that the lifetime of feedback exceeds
that of the spatial index construction.

Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/qgsvectorlayerexporter.sip.in
Expand Up @@ -66,7 +66,7 @@ Writes the contents of vector layer to a different datasource.
:param onlySelected: set to true to export only selected features
:param errorMessage: if non-null, will be set to any error messages
:param options: optional provider dataset options
:param feedback: optional feedback object to show progress and cancelation of export
:param feedback: optional feedback object to show progress and cancellation of export

:return: NoError for a successful export, or encountered error
%End
Expand Down
4 changes: 2 additions & 2 deletions python/core/auto_generated/qgsvectorlayerutils.sip.in
Expand Up @@ -113,7 +113,7 @@ Fetches all values from a specified field name or expression.
:param fieldOrExpression: field name or an expression string
:param ok: will be set to false if field or expression is invalid, otherwise true
:param selectedOnly: set to true to get values from selected features only
:param feedback: optional feedback object to allow cancelation
:param feedback: optional feedback object to allow cancellation

:return: list of fetched values

Expand All @@ -132,7 +132,7 @@ invalid expression results are skipped.
:param ok: will be set to false if field or expression is invalid, otherwise true
:param selectedOnly: set to true to get values from selected features only
:param nullCount: optional pointer to integer to store number of null values encountered in
:param feedback: optional feedback object to allow cancelation
:param feedback: optional feedback object to allow cancellation

:return: list of fetched values

Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/raster/qgsrasterdrawer.sip.in
Expand Up @@ -29,7 +29,7 @@ Draws raster data.
:param p: destination QPainter
:param viewPort: viewport to render
:param qgsMapToPixel: map to pixel converter
:param feedback: optional raster feedback object for cancelation/preview. Added in QGIS 3.0.
:param feedback: optional raster feedback object for cancellation/preview. Added in QGIS 3.0.
%End

protected:
Expand Down
Expand Up @@ -215,7 +215,7 @@ Caller is responsible to free the memory returned.
:param extent: extent of block
:param width: pixel width of block
:param height: pixel height of block
:param feedback: optional raster feedback object for cancelation/preview. Added in QGIS 3.0.
:param feedback: optional raster feedback object for cancellation/preview. Added in QGIS 3.0.
%End

virtual bool setInput( QgsRasterInterface *input );
Expand Down
2 changes: 1 addition & 1 deletion python/core/auto_generated/raster/qgsrasteriterator.sip.in
Expand Up @@ -32,7 +32,7 @@ Start reading of raster band. Raster data can then be retrieved by calling readN
:param nCols: number of columns
:param nRows: number of rows
:param extent: area to read
:param feedback: optional raster feedback object for cancelation/preview. Added in QGIS 3.0.
:param feedback: optional raster feedback object for cancellation/preview. Added in QGIS 3.0.
%End

bool next( int bandNumber, int &columns /Out/, int &rows /Out/, int &topLeftColumn /Out/, int &topLeftRow /Out/, QgsRectangle &blockExtent /Out/ );
Expand Down
Expand Up @@ -101,7 +101,7 @@ by the stored transparency value.
:param redValue: the red portion of the needle to search for in the transparency hay stack
:param greenValue: the green portion of the needle to search for in the transparency hay stack
:param blueValue: the green portion of the needle to search for in the transparency hay stack
:param globalTransparency: the overal transparency level for the layer
:param globalTransparency: the overall transparency level for the layer
%End

bool isEmpty() const;
Expand Down
Expand Up @@ -61,7 +61,7 @@ an empty list will be returned.
The ``context`` argument gives the wider in which the check is being run.

The ``feedback`` argument is used to give progress reports and to support
cancelation of long-running checks.
cancellation of long-running checks.

This is a blocking call, which will run all matching checks in the main
thread and only return when they have all completed.
Expand Down
4 changes: 2 additions & 2 deletions python/gui/auto_generated/locator/qgslocator.sip
Expand Up @@ -104,7 +104,7 @@ class QgsLocator : QObject

void cancelWithoutBlocking();
%Docstring
Triggers cancelation of any current running query without blocking. The query may
Triggers cancellation of any current running query without blocking. The query may
take some time to cancel after calling this.
.. seealso:: cancel()
%End
Expand All @@ -126,7 +126,7 @@ class QgsLocator : QObject
void finished();
%Docstring
Emitted when locator has finished a query, either as a result
of successful completion or early cancelation.
of successful completion or early cancellation.
%End

};
Expand Down