Xavier - Githubissues

jilljenn / tryalgo

Algorithms and data structures for preparing programming competitions: basic and advanced

https://tryalgo.org

MIT License

371 stars 106 forks source link

Xavier #50

Closed xcarcelle closed 5 years ago

xcarcelle commented 5 years ago

Proposition of cosmetic corrections with pycodestyle

jilljenn commented 5 years ago

Thanks! Initially we didn't follow PEP8 for our code because of typesetting requirements. But we are ready to try now!

xcarcelle commented 5 years ago

I will also try to correct the pylint errors/warnings without chaning your code spirit (matrix representation...)

xtof-durr commented 5 years ago

Oui c'est un style de noms de variable que d'indiquer dans le nom le type. Le commentaire de la fonction documente déjà le type, alors je trouve que ce n'est pas nécessaire. L'avantage des noms x,y,z est qu'en général dans le texte du livre on utilisera des noms courts également, style math, pour être concis.

Mais si vous voulez mettre ces préfixes, ça me va aussi. Pourquoi y s'appelle y_value et pas y_table, pour être consistant avec x ?

xtof

xtof-durr commented 5 years ago

Le backslash en début de docstring style

"""\ blabla et encore blabla """

évite que le doc string ne commence par un retour chariot. C'est une bonne idée, acceptons le backslash.

xtof

xcarcelle commented 5 years ago

To sum-up your feelings :

backslah in docstring : ok for you ?
one-character variable naming (C0103: Argument name "n" doesn't conform to snake_case naming style (invalid-name)) : what do you prefer ? if we leave one-character naming, I will put a rule to bypass this pylint rule
for other corrections, do you validate ?

jilljenn commented 5 years ago

Je suis OK pour accepter le backslash à contrecœur :)
Je suis OK pour garder des 1-character variables, parce que ça fait beaucoup de modifications étranges

Merci, après cette modification, je regarderai ce qu'il reste ;)

xcarcelle commented 5 years ago

OK je repars du head de master a jour et je repasse les corrections pylint comme ca (tout sauf les 1-character variable) et je refais une PR. A bientot.