Skip to content

Consistant docstring formatting #32

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

Open
binaryseed wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Consistant docstring formatting #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions felt_python/layer_groups.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ def update_layer_groups(

Args:
map_id: The ID of the map containing the layer groups
layer_group_params_list: List of layer group parameters to update
Each dict must contain at least "name" key
Optional keys include "id", "caption", "ordering_key"
layer_group_params_list: List of layer group parameters to update.
Each dict must contain at least "name" key.
Optional keys include "id", "caption", "ordering_key".
api_token: Optional API token

Returns:
Expand Down
24 changes: 12 additions & 12 deletions felt_python/layers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,10 +296,10 @@ def update_layers(

Args:
map_id: The ID of the map containing the layers
layer_params_list: List of layer parameters to update
Each dict must contain at least an "id" key
Optional keys include "name", "caption",
"metadata", "ordering_key", "refresh_period"
layer_params_list: List of layer parameters to update.
Each dict must contain at least an "id" key.
Optional keys include "name", "caption",
"metadata", "ordering_key", "refresh_period".
api_token: Optional API token

Returns:
Expand Down Expand Up @@ -371,10 +371,10 @@ def create_custom_export(
map_id: The ID of the map containing the layer
layer_id: The ID of the layer to export
output_format: The format to export in.
Options are "csv", "gpkg", or "geojson"
Options are "csv", "gpkg", or "geojson"
filters: Optional list of filters in Felt Style Language filter format
email_on_completion: Whether to send an email when the export completes.
Defaults to True.
Defaults to True.
api_token: Optional API token

Returns:
Expand Down Expand Up @@ -433,12 +433,12 @@ def duplicate_layers(

Args:
duplicate_params: List of layer duplication parameters. Each dict must contain:
- For duplicating a single layer:
- "source_layer_id": ID of the layer to duplicate
- "destination_map_id": ID of the map to duplicate to
- For duplicating a layer group:
- "source_layer_group_id": ID of the layer group to duplicate
- "destination_map_id": ID of the map to duplicate to
- For duplicating a single layer:
- "source_layer_id": ID of the layer to duplicate
- "destination_map_id": ID of the map to duplicate to
- For duplicating a layer group:
- "source_layer_group_id": ID of the layer group to duplicate
- "destination_map_id": ID of the map to duplicate to
api_token: Optional API token

Returns:
Expand Down
8 changes: 4 additions & 4 deletions felt_python/library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ def list_library_layers(source: str = "workspace", api_token: str | None = None)

Args:
source: The source of library layers to list.
Options are:
- "workspace": list layers from your workspace library (default)
- "felt": list layers from the Felt data library
- "all": list layers from both sources
Options are:
- "workspace": list layers from your workspace library (default)
- "felt": list layers from the Felt data library
- "all": list layers from both sources
api_token: Optional API token

Returns:
Expand Down
34 changes: 17 additions & 17 deletions felt_python/maps.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,22 @@ def create_map(
title: The title to be used for the map. Defaults to "Untitled Map"
description: A description to display in the map legend
public_access: The level of access to grant to the map.
Options are "private", "view_only", "view_and_comment",
or "view_comment_and_edit". Defaults to "view_only".
Options are "private", "view_only", "view_and_comment",
or "view_comment_and_edit". Defaults to "view_only".
basemap: The basemap to use for the new map. Defaults to "default".
Valid values are "default", "light", "dark", "satellite",
a valid raster tile URL with {x}, {y}, and {z} parameters,
or a hex color string like #ff0000.
Valid values are "default", "light", "dark", "satellite",
a valid raster tile URL with {x}, {y}, and {z} parameters,
or a hex color string like #ff0000.
lat: If no data has been uploaded to the map, the initial latitude
to center the map display on.
lon: If no data has been uploaded to the map, the initial longitude
to center the map display on.
zoom: If no data has been uploaded to the map, the initial zoom level
for the map to display.
for the map to display.
layer_urls: An array of urls to use to create layers in the map.
Only tile URLs for raster layers are supported at the moment.
Only tile URLs for raster layers are supported at the moment.
workspace_id: The workspace to create the map in.
Defaults to the latest used workspace.
Defaults to the latest used workspace.
api_token: Optional API token

Returns:
Expand Down Expand Up @@ -193,8 +193,8 @@ def create_embed_token(
Args:
map_id: The ID of the map to create an embed token for
user_email: Optionally assign the token to a user email address.
Providing an email will enable the viewer to export data
if the Map allows it.
Providing an email will enable the viewer to export data
if the Map allows it.
api_token: Optional API token

Returns:
Expand All @@ -219,11 +219,11 @@ def add_source_layer(

Args:
map_id: The ID of the map to add the layer to
source_layer_params: Parameters defining the source layer to add
Must include "from" key with one of these values:
- "dataset": requires "dataset_id"
- "sql": requires "source_id" and "query"
- "stac": requires "source_id" and "stac_asset_url"
source_layer_params: Parameters defining the source layer to add.
Must include "from" key with one of these values:
- "dataset": requires "dataset_id"
- "sql": requires "source_id" and "query"
- "stac": requires "source_id" and "stac_asset_url"
api_token: Optional API token

Returns:
Expand Down Expand Up @@ -251,9 +251,9 @@ def duplicate_map(
map_id: The ID of the map to duplicate
title: Optional title for the duplicated map
project_id: The ID of the project to place the duplicated map in
(mutually exclusive with folder_id)
(mutually exclusive with folder_id)
folder_id: The ID of the folder to place the duplicated map in
(mutually exclusive with project_id)
(mutually exclusive with project_id)
api_token: Optional API token

Returns:
Expand Down
2 changes: 1 addition & 1 deletion felt_python/projects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ def create_project(name: str, visibility: str, api_token: str | None = None):
Args:
name: The name to be used for the Project
visibility: Either "workspace" (viewable by all members of the workspace)
or "private" (private to users who are invited)
or "private" (private to users who are invited)
api_token: Optional API token

Returns:
Expand Down
Loading