Skip to content

Commit

Permalink
Simplify param desc. in docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
deeplook committed Sep 7, 2020
1 parent 4a1926d commit fd10b8b
Showing 1 changed file with 16 additions and 21 deletions.
37 changes: 16 additions & 21 deletions xyzspaces/spaces.py
Original file line number Diff line number Diff line change
Expand Up @@ -717,27 +717,22 @@ def features_in_tile(
: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

0 comments on commit fd10b8b

Please sign in to comment.