From 9a416823a040cd7130ccfa9ed5bef2a335f892ef Mon Sep 17 00:00:00 2001 From: Nicolas Frandeboeuf Date: Fri, 29 Dec 2017 15:34:31 +0100 Subject: [PATCH] Fix small errors in documentation --- doc/0.getting_started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/0.getting_started.md b/doc/0.getting_started.md index a2f7c2c..e580083 100644 --- a/doc/0.getting_started.md +++ b/doc/0.getting_started.md @@ -130,14 +130,14 @@ under the `constraints` key. The available constraints are: * `type` is the type of housing you want, either `RENT` (to rent), `SALE` (to buy) or `SHARING` (for a shared housing). -* `housing_types` is a list of house types you are looking for. Values can be +* `house_types` is a list of house types you are looking for. Values can be `APART` (flat), `HOUSE`, `PARKING`, `LAND`, `OTHER` (everything else) or `UNKNOWN` (anything which was not matched with one of the previous categories). * `area` (in m²), `bedrooms`, `cost` (in currency unit), `rooms`: this is a tuple of `(min, max)` values, defining an interval in which the value should lie. A `null` value means that any value is within this bound. -* `postal_codes` is a list of postal codes. You should include any postal code +* `postal_codes` (as strings) is a list of postal codes. You should include any postal code you want, and especially the postal codes close to the precise location you want. * `time_to` is a dictionary of places to compute travel time to them (using