PRAW VS mkdocstrings

To get the relevant IDs, you can use something like PRAW to query the subreddit for the top 1000 posts for example.

Huge thanks to the contributors to PRAW, which is the Python package that does all the heavy lifting relating to Reddit's API that I need for this script.

However, in practice duplicate items were yielded with these smaller numbers. So I increased the limit briefly to 250 in October 2016, and then increased it finally to 301 in December 2016 in order to resolve https://github.com/praw-dev/praw/issues/673. That issue provides an explanation for how 301 came to be.

I have a pretty specific question about PRAW about the code shown here in the source repository. Perhaps this is best directed at one of the authors like /u/bboe.

Woah, dude, you're doing a lot of the heavy lifting trying to make sense of reddit's API yourself. Why not use an existing API wrapper for reddit such as praw? That way, authenticate() isn't really needed and main() could be shortened substantially.

the reddit API is actually really nice: https://github.com/praw-dev/praw

Ha, nearly a year ago now I started implementing something similar in Python using the excellent PRAW, but it never got finished.

That makes sense. For the second one you might take some design tips from praw: https://github.com/praw-dev/praw/tree/master/praw

praw is sequential and he is looking to leverage asyncpraw to work on analytics like comments, submissions, votes etc., any suggestions on this front would help as well.

Mkdocs has the mkdocstrings plugin, offering limited automated API documentation capabilities. It is however nowhere near as capable as Sphinx' autodoc, missing granularity in its configuration, limited intersphinx-like cross-referencing support, and essential features like documentation of inherited members, or the ability to manually describe objects if needed.

mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.

Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.

[1]: https://mkdocstrings.github.io/

Write proper docstrings as you go along (every time you write a new class/method/function you can document what it’s doing as you’ll know why and what from the pattern you chose). Using a tool like mkdocstrings makes maintaining documentation for larger projects automatic.