Skip to content

Python API documentation grammar and rendering updates #874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfisher87 merged 2 commits into from
Aug 23, 2025
Merged

Python API documentation grammar and rendering updates #874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abe2387
updated verb tense for consistency
mtaniguchiking Aug 13, 2025
17ee1a6
remove docstring type hinting in :param lines for consistent rendering
mtaniguchiking Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user_guide/python_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ doc
meaning that anyone working on the same QGIS project file, whether through the
JupyterLab extension or the Python API, will see the edits you make.

Creating a `GISDocument` object without providing a path to an existing file would create a
Creating a `GISDocument` object without providing a path to an existing file creates a
new empty document:

```python
Expand Down
12 changes: 6 additions & 6 deletions python/jupytergis_lab/jupytergis_lab/notebook/gis_document.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,8 +447,8 @@ def add_hillshade_layer(
"""
Add a hillshade layer

:param str url: URL of the hillshade layer
:param str name: The name that will be used for the object in the document, defaults to "Hillshade Layer"
:param url: URL of the hillshade layer
:param name: The name that will be used for the object in the document, defaults to "Hillshade Layer"
:param attribution: The attribution.
"""
if urlParameters is None:
Expand Down Expand Up @@ -637,9 +637,9 @@ def create_color_expr(
"""
Create a color expression used to style the layer

:param Dict color_stops: Dictionary of stop values to [r, g, b, a] colors
:param float band: The band to be colored, defaults to 1.0
:param str interpolation_type: The interpolation function. Can be linear, discrete, or exact, defaults to 'linear'
:param color_stops: Dictionary of stop values to [r, g, b, a] colors
:param band: The band to be colored, defaults to 1.0
:param interpolation_type: The interpolation function. Can be linear, discrete, or exact, defaults to 'linear'
"""

if interpolation_type not in ["linear", "discrete", "exact"]:
Expand Down Expand Up @@ -776,7 +776,7 @@ def clear_filters(self, layer_id: str):
"""
Clear filters on a layer

:param str layer_id: The ID of the layer to clear filters from
:param layer_id: The ID of the layer to clear filters from
"""
layer = self._layers.get(layer_id)

Expand Down
Loading