Skip to content

Commit

Permalink
Fix bulleted list in docs (and add headings to help) (#29)
Browse files Browse the repository at this point in the history
* Fix bulleted list in docs

* Sub-headings
  • Loading branch information
bachya authored Dec 2, 2022
1 parent fa9bd0f commit 3c7cd02
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ async def main() -> None:
asyncio.run(main())
```

### Method Parameters

- `fields` (required): The sensor data fields to include
- `location_type` (optional): An LocationType to filter by
- `max_age` (optional): Filter results modified within these seconds
Expand Down Expand Up @@ -120,6 +122,8 @@ async def main() -> None:
asyncio.run(main())
```

### Method Parameters

- `sensor_index` (required): The sensor index of the sensor to retrieve.
- `fields` (optional): The sensor data fields to include.
- `read_key` (optional): A read key for a private sensor.
Expand All @@ -130,6 +134,12 @@ This method returns a list of `NearbySensorResult` objects that are within a bou
around a given latitude/longitude pair. The list is sorted from nearest to furthest
(i.e., the first index in the list is the closest to the latitude/longitude).

`NearbySensorResult` objects have two properties:

- `sensor`: the corresponding `SensorModel` object
- `distance`: the calculated distance (in kilometers) between this sensor and the provided
latitude/longitude

```python
import asyncio

Expand All @@ -148,11 +158,7 @@ async def main() -> None:
asyncio.run(main())
```

`NearbySensorResult` objects have two properties:

- `sensor`: the corresponding `SensorModel` object
- `distance`: the calculated distance (in kilometers) between this sensor and the provided
latitude/longitude
### Method Parameters

- `fields` (required): The sensor data fields to include
- `latitude` (required): The latitude of the point to measure distance from
Expand Down

0 comments on commit 3c7cd02

Please sign in to comment.