search

buckket / twtxt

Decentralised, minimalist microblogging service for hackers.
http://twtxt.readthedocs.org/en/stable/
MIT License
1.92k stars 79 forks source link

Updated Docstrings #76

Closed JDurstberger closed 8 years ago

JDurstberger commented 8 years ago

Hello buckket,

I updated the docstrings of the twtxt/config.py because all the :param where missing. Also added a docstring for models.Source and added a newline to the end of main.py to follow PEP8.

I look forward to contribute more in the future. Altoyyr

timofurrer commented 8 years ago

Could you add the types to the param documentation? and you might want to squash your commits.

JDurstberger commented 8 years ago

Sure I will add the types. I prefer to keep my commits as small as possible to simplify the reviewing-process, but I think in that case I could squash the ones adding the docstrings to config.*

I will fix this when I get home after work.

timofurrer commented 8 years ago

Thanks.

For the param types you should do something like this:

:param str url: the feed URL to fetch
:param Tweet tweet: the tweet to expand
JDurstberger commented 8 years ago

Hey, I fixed the types - hopefully - to your liking.

They are now recognized by pycharm.

buckket commented 8 years ago

Instead of writing attributes: it’s better to stick to the :param foo: bar notation when documenting the __init__ parameters of a class. (example) Apart from that it looks fine! Thanks for contributing. :+1:

JDurstberger commented 8 years ago

Ok, got it. I fixed that too.

Offtopic, is there some kind of mailing lists where you could discuss questions or should one open a ticket?

JDurstberger commented 8 years ago

Sorry for making this pull-request so messy, but i rebased on the master to increase graph-readability

timofurrer commented 8 years ago

there is an IRC channel #twtxt on FreeNode or you could use gitter - There is a badge in the README with a link to the gitter chat - it's pretty convenient.