integreat-cms icon indicating copy to clipboard operation
integreat-cms copied to clipboard

Published 20 hours ago • verified publisher icon digitalfabrik

Rename "location" to "place"

Open timobrembeck opened this issue 3 years ago • 6 comments

Motivation

The map feature in the app will use "place" as name for POIs whereas we currently use "location", which is inconsistent and could cause confusion for content creators.

Proposed Solution

I suggest to change all occurrences of "location" with "place" where it is used as synonym of "POI", especially in the templates. We can't use "location" as global term because the app already uses this to identify cities/municipalities/regions.

Additional Context

  • This only affects the english term, the German translation "Ort" should remain the same.
  • We could also think about renaming the POI model to Place to keep our code base consistent with the official naming.

timobrembeck avatar Dec 07 '21 08:12 timobrembeck

Hi, I would like to work on this. Is there anyone doing it already?

Carlosbogo avatar Dec 07 '21 10:12 Carlosbogo

@Carlosbogo Awesome, thanks! :tada: No, nobody is doing this yet. Since this is your first contribution, feel free to ask whether specific occurrences should be replaced or not. Unfortunately there are also quite a lot of occurrences of the string "location" which should not be replaced, only where it's used in the context of the POI model.

timobrembeck avatar Dec 07 '21 10:12 timobrembeck

I'm trying to work on it but I'm not sure about how far should the changes go:

Should I look for every instance of the POI class everywhere in the project and if its name is "location", change it to "place"? Should I also change it even if it's not the name of a variable, like in the following case?

https://github.com/Integreat/integreat-cms/blob/3dd68af14b8d9334821789504c7f5af81a1195d6/integreat_cms/api/v3/locations.py#L59

Carlosbogo avatar Dec 08 '21 18:12 Carlosbogo

Hey @Carlosbogo , We realized that we have to clarify some definitions with our other developer teams before we can continue to work on that issue. @svenseeberg will take care of it and inform you on any changes (if you are still willing to contribute :smiley_cat: ).

ulliholtgrave avatar Jan 06 '22 09:01 ulliholtgrave

Yeah, that's perfectly fine by me, just let me know when I should start working on it.

Carlosbogo avatar Jan 16 '22 00:01 Carlosbogo

For reference: https://chat.tuerantuer.org/digitalfabrik/pl/j4tcdangytd48qrru5w9148jsa

svenseeberg avatar Apr 06 '22 15:04 svenseeberg

We decided to not rename it on T31K.

svenseeberg avatar Sep 23 '23 09:09 svenseeberg