GithubHelp home page GithubHelp logo

Renaming about climate HOT 13 CLOSED

bczernecki avatar bczernecki commented on September 24, 2024
Renaming

from climate.

Comments (13)

Nowosad avatar Nowosad commented on September 24, 2024 1

@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.

from climate.

Nowosad avatar Nowosad commented on September 24, 2024 1

Myślę, że nazwy obiektów powinny być teraz okej (ale oczywiście warto wszystko przejrzeć).

from climate.

Nowosad avatar Nowosad commented on September 24, 2024

A później ich nazwy w README/winietach.

from climate.

aglogowski avatar aglogowski commented on September 24, 2024

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 ?

from climate.

Nowosad avatar Nowosad commented on September 24, 2024

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.

from climate.

aglogowski avatar aglogowski commented on September 24, 2024

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:

  1. usuwamy funkcje operacyjne takie jak 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

  1. Pozbywamy się odniesienia imgw i wrzucamy dosłownie wszystko do climate i zmieniamy wszystko jak leci.

from climate.

aglogowski avatar aglogowski commented on September 24, 2024

Wydaje mi się, że ostatecznie tak to powinno wyglądać, krótko zwięźle i klarowanie.
przykład

from climate.

bczernecki avatar bczernecki commented on September 24, 2024

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.

from climate.

Nowosad avatar Nowosad commented on September 24, 2024

@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.

from climate.

aglogowski avatar aglogowski commented on September 24, 2024

@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

from climate.

aglogowski avatar aglogowski commented on September 24, 2024

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ń.

from climate.

bczernecki avatar bczernecki commented on September 24, 2024

Tak, zostajemy przy konwencji zaproponowanej przez @Nowosad , czyli meteo_, hydro_, sounding_wyoming

from climate.

aglogowski avatar aglogowski commented on September 24, 2024

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

from climate.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.