Skip to content

Commit

Permalink
Fix outdated reference to GeoAlgorithmExecutionException in dox
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored and nirvn committed Feb 5, 2020
1 parent 11c39d3 commit 6f82f3c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -529,9 +529,8 @@ algorithm should be canceled and exited early.

This method will not be called if the prepareAlgorithm() step failed (returned ``False``).

c++ implementations of processAlgorithm can throw the QgsProcessingException exception
to indicate that a fatal error occurred within the execution. Python based subclasses
should raise GeoAlgorithmExecutionException for the same purpose.
Implementations of processAlgorithm can throw the QgsProcessingException exception
to indicate that a fatal error occurred within the execution.

:return: A map of algorithm outputs. These may be output layer references, or calculated
values such as statistical calculations. Unless the algorithm subclass overrides
Expand Down
5 changes: 2 additions & 3 deletions src/core/processing/qgsprocessingalgorithm.h
Original file line number Diff line number Diff line change
Expand Up @@ -525,9 +525,8 @@ class CORE_EXPORT QgsProcessingAlgorithm
*
* This method will not be called if the prepareAlgorithm() step failed (returned FALSE).
*
* c++ implementations of processAlgorithm can throw the QgsProcessingException exception
* to indicate that a fatal error occurred within the execution. Python based subclasses
* should raise GeoAlgorithmExecutionException for the same purpose.
* Implementations of processAlgorithm can throw the QgsProcessingException exception
* to indicate that a fatal error occurred within the execution.
*
* \returns A map of algorithm outputs. These may be output layer references, or calculated
* values such as statistical calculations. Unless the algorithm subclass overrides
Expand Down

0 comments on commit 6f82f3c

Please sign in to comment.