Closed Nowosad closed 4 years ago
A później ich nazwy w README/winietach.
Powinniśmy się trzymać też jednej konwencji w kolejności np. dla ogimetu mamy:
ogimet_stations
więc dla imgw powinno być
imgw_meteo_stations
Czy może wogóle napier żeby było station a potem nazwa zbioru ?
Teraz mamy dwie konwencje: funkcje, które widzą użytkownicy meteo_ogimet
i dane, które widzą użytkownicy ogimet_stations
. Mi to odpowiada, ale możemy też to ujednolicić - jak uważasz, która opcja jest lepsza?
W kwestii Twojego przykładu to powinno być ogimet_meteo_stations
i imgw_meteo_stations
.
Funkcje takie jak :
meteo_metadata
clean_metadata_hydro
odnoszą się do funkcji w paczce imgw zmiana tego wymusza zmiane w paczce imgw np. meteo_daily
) co przestaje mieć sens bo w tej paczce są tylko dane imgw więc po co je indeksować tym dopiskiem.
Dwie propozycje:
meteo_metadata
clean_metadata_hydro
, meteo_abbrev
itp. i zostawiamy tylko te funkcje nadrzędne, czyli w sumie będą to: hydro_stations
meteo_stations
meteo_imgw
hydro_imgw
meteo_sounding
zmieniamy im nazwy i pozostawiamy odniesienie do imgw
Wydaje mi się, że ostatecznie tak to powinno wyglądać, krótko zwięźle i klarowanie.
dobra, jak dla mnie to skoro imgw ma być tylko dodatkiem to funkcje ogimet_meteo
i ogimet_stations
powinny być bez przedrostka ogimet_. Tak samo wyoming_meteo_sounding
jest bez sensu, bo jest tylko 1 funkcja do sondowań, więc zostawiłbym samo sounding
.
@bczernecki Bartek, ja myślę odwrotnie. Dopiski z "ogimet" czy "wyoming" mają duży plus - pozwalają na mniej bolesne zmiany (e.g., dodanie innych źródeł danych) w przyszłości. Jak zrobisz tylko sounding
teraz a za rok pojawi się jakaś inna strona z sounding
, którą będziesz chciał dodać to będziesz miał dwie funkcje - stary sounding
i nowy sounding_nowastrona
. Ja bym sugerował, żeby od początku ten pakiet miał wbudowane miejsce na zmiany/dodatki.
@aglogowski funkcje do pobierania danych powinny zaczynać się od meteo_
, hydro_
, sounding_
, a nie od dostawcy danych. Ludzi częściej interesuje co chcą pobrać, a nie od kogo - w ten sposób ławiej jest te funkcje znaleźć poprzez autocompletion niż zgadywać jak został opisany (i czy istnieje) dany dostawca danych.
@Nowosad oki zmiany w tekście można szybko poprawić a chciałem coś zrobić żeby dzisiaj było mniej nawet kosztem robienia czegoś dwa razy :D
Czy generalnie czy w tej burzliwej dyskusji ustaliliśmy i wszyscy się zgadzają, że ma być rodzaj (meteo, hydro, sounding)_ a potem nazwa repo (ogimet,wyoming,imgw) czy nie? bo wyczuwam tutaj dużą rozbieżność zdań.
Tak, zostajemy przy konwencji zaproponowanej przez @Nowosad , czyli meteo_
, hydro_
, sounding_wyoming
W takim razie, ja nie wiem jak to zrobić zeby było poprawnie od strony organizacyjnej więc prosze przyjżeć się funkcji meteo_stations
i hydro_stations
aby na końcu miały dopisek _imgw
bo one są jakoś tak po profesorsku zaczytane i ja napewno coś zepsuje
Myślę, że nazwy obiektów powinny być teraz okej (ale oczywiście warto wszystko przejrzeć).
Zbiory danych (i w efekcie ich odniesienie się w funkcjach) muszą być zaktualizowane. Np.
meteo_stations
teraz powinno nazywać sięmeteo_stations_imgw
, etc:meteo_stations
meteo_metadata
meteo_shortening
meteo_abbrev
??hydro_stations
hydro_shortening
hydro_metadata
hydro_abbrev
??clean_metadata_meteo
clean_metadata_hydro