phyks/flatisfy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge branch 'master' into 'master'

Browse Source 
Small fixes/improvements to getting started documentation

See merge request Phyks/flatisfy!14
This commit is contained in:
Lucas Verney 2017-12-29 22:51:01 +01:00
commit b685a71eab
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/0.getting_started.md
View File

@ -134,14 +134,14 @@ under the `constraints` key. The available constraints are:
* `type` is the type of housing you want, either `RENT` (to rent), `SALE` (to * `type` is the type of housing you want, either `RENT` (to rent), `SALE` (to
buy) or `SHARING` (for a shared housing). 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 `APART` (flat), `HOUSE`, `PARKING`, `LAND`, `OTHER` (everything else) or
`UNKNOWN` (anything which was not matched with one of the previous `UNKNOWN` (anything which was not matched with one of the previous
categories). categories).
* `area` (in m²), `bedrooms`, `cost` (in currency unit), `rooms`: this is a * `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 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. 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 you want, and especially the postal codes close to the precise location you
want. want.
* `time_to` is a dictionary of places to compute travel time to them (using * `time_to` is a dictionary of places to compute travel time to them (using