search

worldbank / GOSTnetsraster

Calculating market access using raster surfaces of friction or travel time
MIT License
6 stars 5 forks source link

Project naming conventions #10

Open elbeejay opened 5 months ago

elbeejay commented 5 months ago

Would it make sense to align the "GOST" projects naming conventions at this time?

elbeejay commented 5 months ago

I guess input from @bpstewar and @g4brielvs might be most relevant here?

g4brielvs commented 4 months ago

Would it make sense to align the "GOST" projects naming conventions at this time?

  • GOSTnets has "GOST" in all caps and then "nets" all lower-case
  • GOSTNetsRaster is in a repository named "GOSTNets_Raster" so there is an underscore making the repository different from the actual Python package. In this case "Nets" has a capital "N" whereas GOSTnets uses a lower-case "n"
  • For the sake of reference, GOST_Urban is not actually a Python package (yet) but the subdirectory holding the modules is named "GOST_Urban" consistent with the repository name, but a different convention from GOSTNetsRaster
  • GOSTRocks has the capitalized "GOST" and "Rocks" begins with a capital "R" in contrast to "GOSTnets" but consistent with "GOSTNetsRaster". The repository name is all lower-case "gostrocks" unlike the other projects.

@elbeejay Thanks! IMHO totally sense. I'd favor GOST + all lower-case (e.g., GOSTraster, GOSTrocks) as the convention for both the packages and project names, but I'll defer to @bpstewar, @andresfchamorro and @bennyistanto.

andresfchamorro commented 4 months ago

I like the proposal and think we can go ahead with GOST + all lower-case without breaking anything. In the future, I would suggest merging GOSTrocks and GOSTNetsRasterinto one (GOSTraster).

elbeejay commented 4 months ago

Just renamed the GOSTnetsraster repository and source code folder to GOSTnetsraster to match new naming scheme (878d0a87a6f4b40fd029d13e17812fa53537e235).

elbeejay commented 4 months ago

I've now done the same to the GOSTurban project (eaa4886025ebc44bd091c46236729f9160a3ea4f).

Should this change apply to the GOST_SAR and GOST_AIS projects too? Unlike the GOST projects mentioned above both SAR and AIS are acronyms, so I understand the need to capitalize them. Tempted to suggest GOST-<name> which would become GOST-urban and GOST-SAR as the hyphen is compatible with PyPI (e.g., pip install GOST-urban is valid) whereas the underscore naming convention isn't. GOSTurban works and is readable, but to me GOSTSAR would be less so. What do you think @andresfchamorro?