Skip to content

Commit

Permalink
Simplify param desc. in docstrings
Browse files Browse the repository at this point in the history 
Signed-off-by: Kharude, Sachin <sachin.kharude@here.com>
  • Loading branch information
Kharude, Sachin committed Sep 7, 2020
1 parent 392dc9c commit 33bd081
Showing 1 changed file with 68 additions and 84 deletions.
152 changes: 68 additions & 84 deletions xyzspaces/spaces.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,27 +281,23 @@ def search(
:param params: A dict to represent additional filter on features to be searched.
Examples:
- If user provides ``params={"p.name": "foo"}``,
Then all features having value of property ``name`` equals ``foo`` will be
returned.
- If user provides ``params={"p.name!": "foo"}``,
Then all features having value of property ``name`` not quals to ``foo``
will be returned.
- If user provides ``params={"p.count=gte": "10"}``,
Then all features having value property ``count`` greater than quals
to ``10`` will be returned.
- If user provides ``params={"p.count=lte": "10"}``,
Then all features having value property ``count`` less than quals to ``10``
will be returned.
- If user provides ``params={"p.count=gt": "10"}``,
Then all features having value of property ``count`` greater than ``10``
will be returned.
- If user provides ``params={"p.count=lt": "10"}``,
Then all features having value of property ``count`` less than ``10``
will be returned.
- If user provides ``params={"p.name=cs": "bar"}``,
Then all features having value of property ``name`` which contains ``bar``
wiil be returned.
- ``params={"p.name": "foo"}``
returns all features with a value of property ``name`` equal to ``foo``.
- ``params={"p.name!": "foo"}``
returns all features with a value of property ``name`` not qual to ``foo``.
- ``params={"p.count=gte": "10"}``
returns all features with a value of property ``count`` greater than or
equal to ``10``.
- ``params={"p.count=lte": "10"}``
returns all features with a value of property ``count`` less than or equal
to ``10``.
- ``params={"p.count=gt": "10"}``
returns all features with a value of property ``count`` greater than ``10``.
- ``params={"p.count=lt": "10"}``
returns all features with a value of property ``count`` less than ``10``.
- ``params={"p.name=cs": "bar"}``
returns all features with a value of property ``name`` which contains
``bar``.
:param selection: A list, only these properties will be returned in features
result list.
:param skip_cache: If set to ``True`` the response is not returned from cache.
Expand Down Expand Up @@ -638,27 +634,23 @@ def features_in_bbox(
:param params: A dict to represent additional filter on features to be searched.
Examples:
- If user provides ``params={"p.name": "foo"}``,
Then all features having value of property ``name`` equals ``foo`` will be
returned.
- If user provides ``params={"p.name!": "foo"}``,
Then all features having value of property ``name`` not quals to ``foo``
will be returned.
- If user provides ``params={"p.count=gte": "10"}``,
Then all features having value property ``count`` greater than quals
to ``10`` will be returned.
- If user provides ``params={"p.count=lte": "10"}``,
Then all features having value property ``count`` less than quals to ``10``
will be returned.
- If user provides ``params={"p.count=gt": "10"}``,
Then all features having value of property ``count`` greater than ``10``
will be returned.
- If user provides ``params={"p.count=lt": "10"}``,
Then all features having value of property ``count`` less than ``10``
will be returned.
- If user provides ``params={"p.name=cs": "bar"}``,
Then all features having value of property ``name`` which contains ``bar``
wiil be returned.
- ``params={"p.name": "foo"}``
returns all features with a value of property ``name`` equal to ``foo``.
- ``params={"p.name!": "foo"}``
returns all features with a value of property ``name`` not qual to ``foo``.
- ``params={"p.count=gte": "10"}``
returns all features with a value of property ``count`` greater than or
equal to ``10``.
- ``params={"p.count=lte": "10"}``
returns all features with a value of property ``count`` less than or equal
to ``10``.
- ``params={"p.count=gt": "10"}``
returns all features with a value of property ``count`` greater than ``10``.
- ``params={"p.count=lt": "10"}``
returns all features with a value of property ``count`` less than ``10``.
- ``params={"p.name=cs": "bar"}``
returns all features with a value of property ``name`` which contains
``bar``.
:param selection: A list, only these properties will be returned in features
result list.
:param skip_cache: If set to ``True`` the response is not returned from cache.
Expand Down Expand Up @@ -807,27 +799,23 @@ def spatial_search(
:param params: A dict to represent additional filter on features to be searched.
Examples:
- If user provides ``params={"p.name": "foo"}``,
Then all features having value of property ``name`` equals ``foo`` will be
returned.
- If user provides ``params={"p.name!": "foo"}``,
Then all features having value of property ``name`` not quals to ``foo``
will be returned.
- If user provides ``params={"p.count=gte": "10"}``,
Then all features having value property ``count`` greater than quals
to ``10`` will be returned.
- If user provides ``params={"p.count=lte": "10"}``,
Then all features having value property ``count`` less than quals to ``10``
will be returned.
- If user provides ``params={"p.count=gt": "10"}``,
Then all features having value of property ``count`` greater than ``10``
will be returned.
- If user provides ``params={"p.count=lt": "10"}``,
Then all features having value of property ``count`` less than ``10``
will be returned.
- If user provides ``params={"p.name=cs": "bar"}``,
Then all features having value of property ``name`` which contains ``bar``
wiil be returned.
- ``params={"p.name": "foo"}``
returns all features with a value of property ``name`` equal to ``foo``.
- ``params={"p.name!": "foo"}``
returns all features with a value of property ``name`` not qual to ``foo``.
- ``params={"p.count=gte": "10"}``
returns all features with a value of property ``count`` greater than or
equal to ``10``.
- ``params={"p.count=lte": "10"}``
returns all features with a value of property ``count`` less than or equal
to ``10``.
- ``params={"p.count=gt": "10"}``
returns all features with a value of property ``count`` greater than ``10``.
- ``params={"p.count=lt": "10"}``
returns all features with a value of property ``count`` less than ``10``.
- ``params={"p.name=cs": "bar"}``
returns all features with a value of property ``name`` which contains
``bar``.
:param selection: A list of strings holding properties values.
:param skip_cache: A Boolean if set to ``True`` the response is not returned from
cache.
Expand Down Expand Up @@ -880,27 +868,23 @@ def spatial_search_geometry(
:param params: A dict to represent additional filter on features to be searched.
Examples:
- If user provides ``params={"p.name": "foo"}``,
Then all features having value of property ``name`` equals ``foo`` will be
returned.
- If user provides ``params={"p.name!": "foo"}``,
Then all features having value of property ``name`` not quals to ``foo``
will be returned.
- If user provides ``params={"p.count=gte": "10"}``,
Then all features having value property ``count`` greater than quals
to ``10`` will be returned.
- If user provides ``params={"p.count=lte": "10"}``,
Then all features having value property ``count`` less than quals to ``10``
will be returned.
- If user provides ``params={"p.count=gt": "10"}``,
Then all features having value of property ``count`` greater than ``10``
will be returned.
- If user provides ``params={"p.count=lt": "10"}``,
Then all features having value of property ``count`` less than ``10``
will be returned.
- If user provides ``params={"p.name=cs": "bar"}``,
Then all features having value of property ``name`` which contains ``bar``
wiil be returned.
- ``params={"p.name": "foo"}``
returns all features with a value of property ``name`` equal to ``foo``.
- ``params={"p.name!": "foo"}``
returns all features with a value of property ``name`` not qual to ``foo``.
- ``params={"p.count=gte": "10"}``
returns all features with a value of property ``count`` greater than or
equal to ``10``.
- ``params={"p.count=lte": "10"}``
returns all features with a value of property ``count`` less than or equal
to ``10``.
- ``params={"p.count=gt": "10"}``
returns all features with a value of property ``count`` greater than ``10``.
- ``params={"p.count=lt": "10"}``
returns all features with a value of property ``count`` less than ``10``.
- ``params={"p.name=cs": "bar"}``
returns all features with a value of property ``name`` which contains
``bar``.
:param selection: A list of strings holding properties values.
:param skip_cache: A Boolean if set to ``True`` the response is not returned from
cache.
Expand Down

0 comments on commit 33bd081

Please sign in to comment.