add docs to pushshift config block

This commit is contained in:
Sean Breckenridge 2021-10-29 00:16:55 -07:00
parent f6c6bed42d
commit 0be9668024

View file

@ -16,6 +16,11 @@ from my.config import reddit as uconfig
@dataclass
class pushshift_config(uconfig.pushshift):
'''
Uses [[https://github.com/seanbreckenridge/pushshift_comment_export][pushshift]] to get access to old comments
'''
# path[s]/glob to the exported JSON data
export_path: Paths
config = make_config(pushshift_config)
@ -41,4 +46,3 @@ def stats() -> Stats:
**stat(comments)
}