Skip to content

Commit 519a30f

Browse files
committed
Standardise dox for signals
1 parent cab2dcf commit 519a30f

File tree

64 files changed

+139
-167
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+139
-167
lines changed

python/core/auto_generated/layout/qgslayout.sip.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,7 @@ Updates the scene bounds of the layout.
624624

625625
void changed();
626626
%Docstring
627-
Is emitted when properties of the layout change. This signal is only
627+
Emitted when properties of the layout change. This signal is only
628628
emitted for settings directly managed by the layout, and is not emitted
629629
when child items change.
630630
%End
@@ -642,7 +642,7 @@ If None, no item is selected.
642642

643643
void refreshed();
644644
%Docstring
645-
Is emitted when the layout has been refreshed and items should also be refreshed
645+
Emitted when the layout has been refreshed and items should also be refreshed
646646
and updated.
647647
%End
648648

python/core/auto_generated/layout/qgslayoutatlas.sip.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ Emitted when the coverage layer for the atlas changes.
371371

372372
void messagePushed( const QString &message );
373373
%Docstring
374-
Is emitted when the atlas has an updated status bar ``message``.
374+
Emitted when the atlas has an updated status bar ``message``.
375375
%End
376376

377377
void numberFeaturesChanged( int numFeatures );
@@ -381,7 +381,7 @@ Emitted when the number of features for the atlas changes.
381381

382382
void featureChanged( const QgsFeature &feature );
383383
%Docstring
384-
Is emitted when the current atlas ``feature`` changes.
384+
Emitted when the current atlas ``feature`` changes.
385385
%End
386386

387387
void renderBegun();

python/core/auto_generated/layout/qgslayoutitemmap.sip.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,7 @@ Calculates the extent to request and the yShift of the top-left point in case of
612612

613613
void extentChanged();
614614
%Docstring
615-
Is emitted when the map's extent changes.
615+
Emitted when the map's extent changes.
616616

617617
.. seealso:: :py:func:`setExtent`
618618

@@ -621,7 +621,7 @@ Is emitted when the map's extent changes.
621621

622622
void mapRotationChanged( double newRotation );
623623
%Docstring
624-
Is emitted when the map's rotation changes.
624+
Emitted when the map's rotation changes.
625625

626626
.. seealso:: :py:func:`setMapRotation`
627627

@@ -630,7 +630,7 @@ Is emitted when the map's rotation changes.
630630

631631
void preparedForAtlas();
632632
%Docstring
633-
Is emitted when the map has been prepared for atlas rendering, just before actual rendering
633+
Emitted when the map has been prepared for atlas rendering, just before actual rendering
634634
%End
635635

636636
void layerStyleOverridesChanged();

python/core/auto_generated/layout/qgslayoutitempicture.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ Forces a recalculation of the picture's frame size
310310
signals:
311311
void pictureRotationChanged( double newRotation );
312312
%Docstring
313-
Is emitted on picture rotation change
313+
Emitted on picture rotation change
314314
%End
315315

316316
protected:

python/core/auto_generated/qgsnetworkaccessmanager.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ created in any thread.
326326

327327
void finished( QgsNetworkReplyContent reply );
328328
%Docstring
329-
This signal is emitted whenever a pending network reply is finished.
329+
Emitted whenever a pending network reply is finished.
330330

331331
The ``reply`` parameter will contain a QgsNetworkReplyContent object, containing all the useful
332332
information relating to the reply, including headers and reply content.

python/core/auto_generated/qgsofflineediting.sip.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,20 @@ Synchronize to remote layers
6161

6262
void progressStarted();
6363
%Docstring
64-
The signal is emitted when the process has started.
64+
Emitted when the process has started.
6565
%End
6666

6767
void layerProgressUpdated( int layer, int numLayers );
6868
%Docstring
69-
Is emitted whenever a new layer is being processed.
69+
Emitted whenever a new layer is being processed.
7070
It is possible to estimate the progress of the complete operation by
7171
comparing the index of the current ``layer`` to the total amount
7272
``numLayers``.
7373
%End
7474

7575
void progressModeSet( QgsOfflineEditing::ProgressMode mode, int maximum );
7676
%Docstring
77-
Is emitted when the mode for the progress of the current operation is
77+
Emitted when the mode for the progress of the current operation is
7878
set.
7979

8080
:param mode: progress mode

python/core/auto_generated/qgsrelationmanager.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Discover all the relations available from the current layers.
128128
signals:
129129
void relationsLoaded();
130130
%Docstring
131-
This signal is emitted when the relations were loaded after reading a project
131+
Emitted when the relations were loaded after reading a project
132132
%End
133133

134134
void changed();

python/core/auto_generated/qgsvectorlayer.sip.in

+18-18
Original file line numberDiff line numberDiff line change
@@ -2329,7 +2329,7 @@ by the backend data provider).
23292329

23302330
void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect );
23312331
%Docstring
2332-
This signal is emitted when selection was changed
2332+
Emitted when selection was changed
23332333

23342334
:param selected: Newly selected feature ids
23352335
:param deselected: Ids of all features which have previously been selected but are not any more
@@ -2338,7 +2338,7 @@ This signal is emitted when selection was changed
23382338

23392339
void layerModified();
23402340
%Docstring
2341-
This signal is emitted when modifications has been done on layer
2341+
Emitted when modifications has been done on layer
23422342
%End
23432343

23442344
void allowCommitChanged();
@@ -2350,37 +2350,37 @@ Emitted whenever the allowCommitChanged() property of this layer changes.
23502350

23512351
void beforeModifiedCheck() const;
23522352
%Docstring
2353-
Is emitted, when layer is checked for modifications. Use for last-minute additions
2353+
Emitted when the layer is checked for modifications. Use for last-minute additions.
23542354
%End
23552355

23562356
void beforeEditingStarted();
23572357
%Docstring
2358-
Is emitted, before editing on this layer is started
2358+
Emitted before editing on this layer is started.
23592359
%End
23602360

23612361
void editingStarted();
23622362
%Docstring
2363-
Is emitted, when editing on this layer has started
2363+
Emitted when editing on this layer has started.
23642364
%End
23652365

23662366
void editingStopped();
23672367
%Docstring
2368-
Is emitted, when edited changes successfully have been written to the data provider
2368+
Emitted when edited changes have been successfully written to the data provider.
23692369
%End
23702370

23712371
void beforeCommitChanges();
23722372
%Docstring
2373-
Is emitted, before changes are committed to the data provider
2373+
Emitted before changes are committed to the data provider.
23742374
%End
23752375

23762376
void beforeRollBack();
23772377
%Docstring
2378-
Is emitted, before changes are rolled back
2378+
Emitted before changes are rolled back.
23792379
%End
23802380

23812381
void afterRollBack();
23822382
%Docstring
2383-
Is emitted, after changes are rolled back
2383+
Emitted after changes are rolled back.
23842384

23852385
.. versionadded:: 3.4
23862386
%End
@@ -2451,7 +2451,7 @@ If features are deleted outside of an edit command, this signal will be emitted
24512451

24522452
void updatedFields();
24532453
%Docstring
2454-
Is emitted, whenever the fields available from this layer have been changed.
2454+
Emitted whenever the fields available from this layer have been changed.
24552455
This can be due to manually adding attributes or due to a join.
24562456
%End
24572457

@@ -2464,7 +2464,7 @@ Emitted when the layer's subset string has changed.
24642464

24652465
void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant &value );
24662466
%Docstring
2467-
Is emitted whenever an attribute value change is done in the edit buffer.
2467+
Emitted whenever an attribute value change is done in the edit buffer.
24682468
Note that at this point the attribute change is not yet saved to the provider.
24692469

24702470
:param fid: The id of the changed feature
@@ -2474,7 +2474,7 @@ Note that at this point the attribute change is not yet saved to the provider.
24742474

24752475
void geometryChanged( QgsFeatureId fid, const QgsGeometry &geometry );
24762476
%Docstring
2477-
Is emitted whenever a geometry change is done in the edit buffer.
2477+
Emitted whenever a geometry change is done in the edit buffer.
24782478
Note that at this point the geometry change is not yet saved to the provider.
24792479

24802480
:param fid: The id of the changed feature
@@ -2483,27 +2483,27 @@ Note that at this point the geometry change is not yet saved to the provider.
24832483

24842484
void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes );
24852485
%Docstring
2486-
This signal is emitted, when attributes are deleted from the provider
2486+
Emitted when attributes are deleted from the provider
24872487
%End
24882488
void committedAttributesAdded( const QString &layerId, const QList<QgsField> &addedAttributes );
24892489
%Docstring
2490-
This signal is emitted, when attributes are added to the provider
2490+
Emitted when attributes are added to the provider
24912491
%End
24922492
void committedFeaturesAdded( const QString &layerId, const QgsFeatureList &addedFeatures );
24932493
%Docstring
2494-
This signal is emitted, when features are added to the provider
2494+
Emitted when features are added to the provider
24952495
%End
24962496
void committedFeaturesRemoved( const QString &layerId, const QgsFeatureIds &deletedFeatureIds );
24972497
%Docstring
2498-
This signal is emitted, when features are deleted from the provider
2498+
Emitted when features are deleted from the provider
24992499
%End
25002500
void committedAttributeValuesChanges( const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues );
25012501
%Docstring
2502-
This signal is emitted, when attribute value changes are saved to the provider
2502+
Emitted when attribute value changes are saved to the provider
25032503
%End
25042504
void committedGeometriesChanges( const QString &layerId, const QgsGeometryMap &changedGeometries );
25052505
%Docstring
2506-
This signal is emitted, when geometry changes are saved to the provider
2506+
Emitted when geometry changes are saved to the provider
25072507
%End
25082508

25092509
void labelingFontNotFound( QgsVectorLayer *layer, const QString &fontfamily );

python/core/auto_generated/qgsvectorlayercache.sip.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -281,13 +281,13 @@ layer() will still return a valid pointer for cleanup purpose.
281281

282282
void attributeValueChanged( QgsFeatureId fid, int field, const QVariant &value );
283283
%Docstring
284-
Is emitted when an attribute is changed. Is re-emitted after the layer itself emits this signal.
284+
Emitted when an attribute is changed. Is re-emitted after the layer itself emits this signal.
285285
You should connect to this signal, to be sure, to not get a cached value if querying the cache.
286286
%End
287287

288288
void featureAdded( QgsFeatureId fid );
289289
%Docstring
290-
Is emitted, when a new feature has been added to the layer and this cache.
290+
Emitted when a new feature has been added to the layer and this cache.
291291
You should connect to this signal instead of the layers', if you want to be sure
292292
that this cache has updated information for the new feature
293293

python/core/auto_generated/qgsvectorlayereditbuffer.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Returns true if the specified feature ID has been deleted but not committed.
214214
signals:
215215
void layerModified();
216216
%Docstring
217-
This signal is emitted when modifications has been done on layer
217+
Emitted when modifications has been done on layer
218218
%End
219219

220220
void featureAdded( QgsFeatureId fid );

python/core/auto_generated/symbology/qgsstyle.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,7 @@ name or tag changes.
498498

499499
void groupsModified();
500500
%Docstring
501-
Is emitted every time a tag or smartgroup has been added, removed, or renamed
501+
Emitted every time a tag or smartgroup has been added, removed, or renamed
502502
%End
503503

504504
void entityTagsChanged( QgsStyle::StyleEntity entity, const QString &name, const QStringList &newTags );

python/gui/auto_generated/attributetable/qgsattributetabledelegate.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Sets data from model into the editor. Overloads default method
6767

6868
void actionColumnItemPainted( const QModelIndex &index ) const;
6969
%Docstring
70-
Is emitted when an action column item is painted.
70+
Emitted when an action column item is painted.
7171
The consumer of this signal can initialize the index widget.
7272

7373
.. note::

python/gui/auto_generated/attributetable/qgsattributetablefiltermodel.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ is shown.
202202

203203
void sortColumnChanged( int column, Qt::SortOrder order );
204204
%Docstring
205-
Is emitted whenever the sort column is changed
205+
Emitted whenever the sort column is changed
206206

207207
:param column: The sort column
208208
:param order: The sort order

python/gui/auto_generated/attributetable/qgsattributetableview.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Saves geometry to the settings on close
128128

129129
void willShowContextMenu( QMenu *menu, const QModelIndex &atIndex );
130130
%Docstring
131-
Is emitted, in order to provide a hook to add additional* menu entries to the context menu.
131+
Emitted in order to provide a hook to add additional* menu entries to the context menu.
132132

133133
:param menu: If additional QMenuItems are added, they will show up in the context menu.
134134
:param atIndex: The QModelIndex, to which the context menu belongs. Relative to the source model.

python/gui/auto_generated/attributetable/qgsdualview.sip.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -227,19 +227,19 @@ Cancel the progress dialog (if any)
227227

228228
void displayExpressionChanged( const QString &expression );
229229
%Docstring
230-
Is emitted, whenever the display expression is successfully changed
230+
Emitted whenever the display expression is successfully changed
231231

232232
:param expression: The expression that was applied
233233
%End
234234

235235
void filterChanged();
236236
%Docstring
237-
Is emitted, whenever the filter changes
237+
Emitted whenever the filter changes
238238
%End
239239

240240
void filterExpressionSet( const QString &expression, QgsAttributeForm::FilterType type );
241241
%Docstring
242-
Is emitted when a filter expression is set using the view.
242+
Emitted when a filter expression is set using the view.
243243

244244
:param expression: filter expression
245245
:param type: filter type

python/gui/auto_generated/attributetable/qgsfeaturelistview.sip.in

+3-3
Original file line numberDiff line numberDiff line change
@@ -115,22 +115,22 @@ setFeatureSelectionManager
115115

116116
void currentEditSelectionChanged( QgsFeature &feat );
117117
%Docstring
118-
Is emitted, whenever the current edit selection has been changed.
118+
Emitted whenever the current edit selection has been changed.
119119

120120
:param feat: the feature, which will be edited.
121121
%End
122122

123123
void displayExpressionChanged( const QString &expression );
124124
%Docstring
125-
Is emitted, whenever the display expression is successfully changed
125+
Emitted whenever the display expression is successfully changed
126126

127127
:param expression: The expression that was applied
128128
%End
129129

130130

131131
void willShowContextMenu( QgsActionMenu *menu, const QModelIndex &atIndex );
132132
%Docstring
133-
Is emitted, when the context menu is created to add the specific actions to it
133+
Emitted when the context menu is created to add the specific actions to it
134134

135135
:param menu: is the already created context menu
136136
:param atIndex: is the position of the current feature in the model

python/gui/auto_generated/attributetable/qgsifeatureselectionmanager.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Returns reference to identifiers of selected features
6161

6262
void selectionChanged( const QgsFeatureIds &selected, const QgsFeatureIds &deselected, bool clearAndSelect );
6363
%Docstring
64-
This signal is emitted when selection was changed
64+
Emitted when selection was changed.
6565

6666
:param selected: Newly selected feature ids
6767
:param deselected: Ids of all features which have previously been selected but are not any more

python/gui/auto_generated/layertree/qgslayertreeviewindicator.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Sets tool tip text
5151
signals:
5252
void clicked( const QModelIndex &index );
5353
%Docstring
54-
Signal that is emitted when user clicks on the indicator
54+
Emitted when user clicks on the indicator
5555
%End
5656

5757
};

python/gui/auto_generated/layout/qgslayoutruler.sip.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ the view.
7676
signals:
7777
void cursorPosChanged( QPointF );
7878
%Docstring
79-
Is emitted when mouse cursor coordinates change
79+
Emitted when mouse cursor coordinates change
8080
%End
8181

8282
protected:

python/gui/auto_generated/layout/qgslayoutview.sip.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -517,12 +517,12 @@ Emitted when the current ``tool`` is changed.
517517

518518
void zoomLevelChanged();
519519
%Docstring
520-
Is emitted whenever the zoom level of the view is changed.
520+
Emitted whenever the zoom level of the view is changed.
521521
%End
522522

523523
void cursorPosChanged( QPointF layoutPoint );
524524
%Docstring
525-
Is emitted when the mouse cursor coordinates change within the view.
525+
Emitted when the mouse cursor coordinates change within the view.
526526
The ``layoutPoint`` argument indicates the cursor position within
527527
the layout coordinate system.
528528
%End

0 commit comments

Comments
 (0)