Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Don't indent multiline versionadded/deprecated tags
Turns out there isn't any valid ones anyway - the only
multiline versionadded tags are due to incorrect ordering
of brief/since tags (which is fixed in a different PR)
  • Loading branch information
nyalldawson committed May 27, 2018
1 parent 9f650fe commit 0e75f6e
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion python/analysis/auto_generated/network/qgsgraph.sip.in
Expand Up @@ -16,7 +16,7 @@ class QgsGraphEdge
%Docstring

.. versionadded:: 3.0
This class implements a graph edge
This class implements a graph edge
%End

%TypeHeaderCode
Expand Down
Expand Up @@ -13,7 +13,7 @@ class QgsNetworkDistanceStrategy : QgsNetworkStrategy
%Docstring

.. versionadded:: 3.0
Strategy for caclulating edge cost based on its length. Should be
Strategy for caclulating edge cost based on its length. Should be
used for finding shortest path between two points.
%End

Expand Down
Expand Up @@ -20,7 +20,7 @@ class QgsNetworkStrategy
%Docstring

.. versionadded:: 3.0
QgsNetworkStrategy defines strategy used for calculation of the edge cost. For example it can
QgsNetworkStrategy defines strategy used for calculation of the edge cost. For example it can
take into account travel distance, amount of time or money. Currently there are two strategies
implemented in the analysis library: QgsNetworkDistanceStrategy and QgsNetworkSpeedStrategy.
QgsNetworkStrategy implemented using "strategy" design pattern.
Expand Down
Expand Up @@ -15,7 +15,7 @@ class QgsVectorLayerDirector : QgsGraphDirector
%Docstring

.. versionadded:: 3.0
Determine making the graph from vector line layer
Determine making the graph from vector line layer
%End

%TypeHeaderCode
Expand Down
Expand Up @@ -14,7 +14,7 @@ class QgsNativeAlgorithms: QgsProcessingProvider
%Docstring

.. versionadded:: 3.0
Native c++ processing algorithm provider.
Native c++ processing algorithm provider.
%End

%TypeHeaderCode
Expand Down
12 changes: 6 additions & 6 deletions python/core/auto_generated/qgsmaprendererjob.sip.in
Expand Up @@ -99,18 +99,18 @@ This should not be used if cached labeling was redrawn - see usedCachedLabels().
%Docstring

.. versionadded:: 3.0
Set the feature filter provider used by the QgsRenderContext of
each LayerRenderJob.
Ownership is not transferred and the provider must not be deleted
before the render job.
Set the feature filter provider used by the QgsRenderContext of
each LayerRenderJob.
Ownership is not transferred and the provider must not be deleted
before the render job.
%End

const QgsFeatureFilterProvider *featureFilterProvider() const;
%Docstring

.. versionadded:: 3.0
Returns the feature filter provider used by the QgsRenderContext of
each LayerRenderJob.
Returns the feature filter provider used by the QgsRenderContext of
each LayerRenderJob.
%End

struct Error
Expand Down
Expand Up @@ -14,7 +14,7 @@ class QgsMapLayerConfigWidgetFactory
%Docstring

.. versionadded:: 2.16
Factory class for creating custom map layer property pages
Factory class for creating custom map layer property pages
%End

%TypeHeaderCode
Expand Down
4 changes: 2 additions & 2 deletions scripts/sipify.pl
Expand Up @@ -217,11 +217,11 @@ sub processDoxygenLine {
return "";
}
if ( $line =~ m/\\since .*?([\d\.]+)/i ) {
$INDENT = ' ';
$INDENT = '';
return "\n.. versionadded:: $1\n";
}
if ( $line =~ m/\\deprecated (.*)/i ) {
$INDENT = ' ';
$INDENT = '';
return "\n.. deprecated:: $1\n";
}

Expand Down

0 comments on commit 0e75f6e

Please sign in to comment.