snscrape icon indicating copy to clipboard operation
snscrape copied to clipboard

Document the individual modules better

Open JustAnotherArchivist opened this issue 7 years ago • 4 comments

The modules are currently not documented very well, especially their limitations (e.g. Twitter not discovering retweets).

JustAnotherArchivist avatar Sep 28 '18 11:09 JustAnotherArchivist

I'd love to help with this!

ppival avatar Sep 29 '20 17:09 ppival

That would be greatly appreciated!

Preferably, this part would be directly in the code as docstrings since that makes it much less likely to forget about updating the docs on code changes. It would also automatically serve as a partial documentation of the API (#7). I'll have to think a bit about how to make it easily accessible, but that's down the line anyway.

JustAnotherArchivist avatar Sep 29 '20 18:09 JustAnotherArchivist

Numpy docstrings are a great human- and machine- readable format for docstrings: https://numpydoc.readthedocs.io/en/latest/format.html

reynoldsnlp avatar Dec 03 '20 20:12 reynoldsnlp

Unfortunately, numpydoc doesn't support proper type hints: https://github.com/numpy/numpydoc/issues/196

The ideal solution would be something like https://github.com/agronholm/sphinx-autodoc-typehints/issues/149 I think. I haven't done much research on this though (yet).

JustAnotherArchivist avatar Dec 03 '20 23:12 JustAnotherArchivist