Update documentation for new Python frontend #3178
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Needed for tabbed code blocks.
mtmail
reviewed
Aug 28, 2023
docs/admin/Deployment-Python.md
Outdated
| choice between [Falcon](https://falcon.readthedocs.io/en/stable/) | ||
| and [Starlette](https://www.starlette.io/) as the ASGI framework. | ||
|
|
||
| This section gives a quick overview on how to configure Nginx to server |
mtmail
reviewed
Aug 28, 2023
docs/admin/Deployment-Python.md
Outdated
| [Nginx](https://nginx.org/en/docs/) for background information on how to configure it. | ||
|
|
||
| !!! Note | ||
| Throughout this page, we assume that your Nominatim project directory is |
There was a problem hiding this comment.
"that" in this and next line can be removed
mtmail
reviewed
Aug 28, 2023
docs/admin/Deployment-Python.md
Outdated
|
|
||
| ### Installing the required packages | ||
|
|
||
| The recommended way to deploy Python ASGI application is to run |
mtmail
reviewed
Aug 28, 2023
docs/admin/Deployment-Python.md
Outdated
|
|
||
| ### Setting up Nominatim as a systemd job | ||
|
|
||
| Next you need to set up the application that serves Nominatim. This is |
There was a problem hiding this comment.
section starts with "set up the application" but ends "this sets the service up". I think it should be service
mtmail
reviewed
Aug 28, 2023
docs/admin/Import.md
Outdated
|
|
||
| If you want to be able to search for places by their type through | ||
| If you want to be able to search for places by their type using |
There was a problem hiding this comment.
I'd skip the "If you want"
docs/api/Details.md
Outdated
| @@ -2,13 +2,18 @@ | |||
|
|
|||
| Show all details about a single place saved in the database. | |||
|
|
|||
| This API endpoint is meant for visual inspection of the data in the database | |||
| and is meant for use with [Nominatim-UI](https://github.com/osm-search/nominatim-ui/). | |||
There was a problem hiding this comment.
Second "is meant" can be removed
docs/api/Details.md
Outdated
|
|
||
| Wrap JSON output in a callback function (JSONP) i.e. `<string>(<json>)`. | ||
| When given, then JSON output will be wrapped in a callback function with |
There was a problem hiding this comment.
"When set" might work to avoid using "given" twice
docs/api/Reverse.md
Outdated
|
|
||
| The `address` layer contains all places that make up an address: | ||
| address points with house numbers, streets, inhabited places (suburbs, villages, | ||
| cities, states tec.) and administrative boundaries. |
docs/api/Reverse.md
Outdated
| address points with house numbers, streets, inhabited places (suburbs, villages, | ||
| cities, states tec.) and administrative boundaries. | ||
|
|
||
| The `poi` layer selects all point of interest. This includes classic POIs like |
docs/library/Result-Handling.md
Outdated
| @@ -0,0 +1,58 @@ | |||
| # Result handling | |||
|
|
|||
| The search functions of the Nominatim API always return a result object that | |||
There was a problem hiding this comment.
A lot of 'that'.
return a result object containing ...
results and utility functions which allow...
docs/library/Result-Handling.md
Outdated
|
|
||
| When the `address_details` parameter is set, then functions return not | ||
| only information about the result place but also about the place that | ||
| make up the address. This information is almost always required, when you |
docs/library/Result-Handling.md
Outdated
| list of `AddressLine` objects with the country information last. The list also | ||
| contains the result place itself and some artificial entries, for example, | ||
| for the housenumber or the country code. This makes processing and creating | ||
| a full address easiert. |
nominatim/api/types.py
Outdated
| ADDRESS = enum.auto() | ||
| """ The address layer contains all places that have a fully qualified |
There was a problem hiding this comment.
3x 'that'
all places having a fully ...
places which can be part of ...
nominatim/tokenizer/base.py
Outdated
|
|
||
| Arguments: | ||
| conn: Open connection to the database which may be used to | ||
| retrive the words. |
|
Thank you for the extensive review. The comments should be all fixed in the latest commit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a rather massive overhaul of the documentation including:
I've reached the limits of the ReadtheDocs theme, so finally had to switch to the Material theme. I've also updated to a newer version of mkdocsstring which brings some visual changes how the parameters are presented.