search

airlog / flavority-api

RESTful API for the tastiest website
0 stars 1 forks source link

Commented code #28

Open FilipJany opened 10 years ago

FilipJany commented 10 years ago

See #20

robin92 commented 10 years ago

Filip, usunąłeś komentarze poprawnie rozpoznawane przez Sphinxa i dodałeś komentarze, które w żaden sposób nie udokumentują kodu. W Pythonie kod dokumentuje się tak:

# nie wiem czy to działa zawsze, ale u mnie tak
def super_funkcja(graf):
    """
    Znajduje rozwiązanie jak narysować graf planarny w czasie *O(mlogn)*, gdzie *m* jest ilością łuków i *n* ilością wierzchołków. 
    """
    # tutaj komentarz nic nie wnoszący do dokumentacji
    # i duzo duzo kodu, w koncu do super funkcja
    return rozwiaz_graf(graf)

Z tego powodu nie przeczytam nawet tego co wpisałeś w tych komentarzach. Proszę Cię także byś nie usuwał już wpisanych komentarzy.

Przed dalszą pracą zapoznaj się z tutorialem i małym przykładem Sphinxa.

EDIT. W ogóle dokumentacja bardziej przydałaby się na Wiki w takiej formie jak już jest niż w kodzie :-) Pozwoliłem sobie edytować twój post i dopisać adnotacje, żeby GitHub podlinkował ten PR i commity do istniejącego Issue

FilipJany commented 10 years ago

Cholera na strone doxygena widnieje przyklad z takimi komentarzami jakie tu napisalem, lecz po wygenerowaniu ich nie lapie, co za shit, pozmieniam