Skip to content

Commit 58bb222

Browse files
Python API documentation grammar and rendering updates (#874)
* updated verb tense for consistency * remove docstring type hinting in :param lines for consistent rendering
1 parent 1a2f469 commit 58bb222

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

docs/user_guide/python_api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ doc
2121
meaning that anyone working on the same QGIS project file, whether through the
2222
JupyterLab extension or the Python API, will see the edits you make.
2323

24-
Creating a `GISDocument` object without providing a path to an existing file would create a
24+
Creating a `GISDocument` object without providing a path to an existing file creates a
2525
new empty document:
2626

2727
```python

python/jupytergis_lab/jupytergis_lab/notebook/gis_document.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -447,8 +447,8 @@ def add_hillshade_layer(
447447
"""
448448
Add a hillshade layer
449449
450-
:param str url: URL of the hillshade layer
451-
:param str name: The name that will be used for the object in the document, defaults to "Hillshade Layer"
450+
:param url: URL of the hillshade layer
451+
:param name: The name that will be used for the object in the document, defaults to "Hillshade Layer"
452452
:param attribution: The attribution.
453453
"""
454454
if urlParameters is None:
@@ -638,9 +638,9 @@ def create_color_expr(
638638
"""
639639
Create a color expression used to style the layer
640640
641-
:param Dict color_stops: Dictionary of stop values to [r, g, b, a] colors
642-
:param float band: The band to be colored, defaults to 1.0
643-
:param str interpolation_type: The interpolation function. Can be linear, discrete, or exact, defaults to 'linear'
641+
:param color_stops: Dictionary of stop values to [r, g, b, a] colors
642+
:param band: The band to be colored, defaults to 1.0
643+
:param interpolation_type: The interpolation function. Can be linear, discrete, or exact, defaults to 'linear'
644644
"""
645645

646646
if interpolation_type not in ["linear", "discrete", "exact"]:
@@ -777,7 +777,7 @@ def clear_filters(self, layer_id: str):
777777
"""
778778
Clear filters on a layer
779779
780-
:param str layer_id: The ID of the layer to clear filters from
780+
:param layer_id: The ID of the layer to clear filters from
781781
"""
782782
layer = self._layers.get(layer_id)
783783

0 commit comments

Comments
 (0)