Update the documentation for the category series - #4166
Open
Itz-Agasta wants to merge 5 commits into
Open
Conversation
Itz-Agasta
marked this pull request as draft
August 14, 2026 07:33
mtmail
reviewed
Aug 14, 2026
mtmail
reviewed
Aug 14, 2026
Collaborator
|
Well caught that documentation for place_entrance and place_associated_street was missing so far. |
Itz-Agasta
force-pushed
the
docs-category-series
branch
from
August 14, 2026 09:18
5fd27f9 to
4739081
Compare
lonvia
reviewed
Aug 14, 2026
lonvia
left a comment
Member
There was a problem hiding this comment.
Aaahhh, now we are really running into the ambiguity between the existing 'category' and the new 'categories'.
As there are already a lot of references to "main tag" when talking about the class/type columns, I would suggest that we stick to that name and drop all references to 'category' for that. So sooner or later we have the values in the category column as the only 'category'.
Also, can you please mark the 'categories' API parameter as deprecated. One of the next PRs should be to simply map it to include and some day it should go away completely (similar to Photon's osm_tag.)
The place table holds a single row per OSM object now, with a categories column that carries all of its main tags. Document that, the categories column on placex and the tables that were added since the page was last touched: place_entrance, placex_entrance, place_associated_street and location_area_country. The place_classtype tables are gone, so drop them from the list of auxiliary tables. Also bring the diagrams back in line with the schema. search_name lost its search_rank column a while ago and location_postcodes gained is_area, while its centroid was missing from the diagram because of a typo.
An object with several main tags gets one database entry with a category per tag now, instead of one entry per tag. Describe how a category is built from a main tag and which of the main tags ends up as the class and type of the place. Fallback tags always contribute a category now, they only lose the race for class and type.
Itz-Agasta
force-pushed
the
docs-category-series
branch
from
August 20, 2026 03:59
4739081 to
06ab0fc
Compare
Itz-Agasta
marked this pull request as ready for review
August 20, 2026 04:00
This file contains hidden or 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
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.
Summary
Documentation follow-up for #4106, #4146, #4163, and #4164 as part of the GSoC period.
AI usage
After I was done, asked ai to review it against the codebase and check if I was missing anything....It made a few patches on its own.
Contributor guidelines (mandatory)