search

rezemika / humanized_opening_hours

A parser for the opening_hours fields from OpenStreetMap
GNU Affero General Public License v3.0
26 stars 20 forks source link

Améliorer et vérifier la documentation #2

Closed rezemika closed 6 years ago

rezemika commented 6 years ago

Il y a quelques imprécisions dans le README et les docstrings. Il faudrait harmoniser et corriger tout cela.

Aussi, il y a une petite erreur dans le README.

>>> import humanized_opening_hours
>>> field = "Mo-Fr 06:00-21:00; Sa,Su 07:00-21:00"
>>> hoh = HumanizedOpeningHours(field)  # Devrait être "humanized_opening_hours.HumanizedOpeningHours(field)"
[...]
knil-sama commented 6 years ago

Salut @rezemika , je serais bien interessé pour faire cela, est ce que la convention napoleon te convient pour les docstring ?

rezemika commented 6 years ago

Salut ! Pourquoi pas. Jusqu'à présent, je suivais la convention numpy, mais je suis ouvert à d'autres choses. :)

knil-sama commented 6 years ago

Bon je reste sur numpy dans ce cas là, je pense sortir la pour jeudi.

knil-sama commented 6 years ago

4 pull request a valider