From 536d7875a1c7ddac9e46028bf28975046c64ae82 Mon Sep 17 00:00:00 2001 From: Scott Date: Mon, 28 Nov 2016 20:56:08 -0600 Subject: [PATCH] Improves config files self documentation --- shreddit.yml.example | 6 ++++++ shreddit/shreddit.yml.example | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/shreddit.yml.example b/shreddit.yml.example index 498e98f..3fe276b 100644 --- a/shreddit.yml.example +++ b/shreddit.yml.example @@ -1,6 +1,7 @@ --- # Login details for Reddit. Fill out if you don't wish # to be prompted for a login every time you run Shreddit. +# If your username or password has characters that could cause problems, surround them in quotes. ### NOTE: This may be deprecated as you can specify in praw.ini instead username: password: @@ -39,6 +40,11 @@ whitelist: [AskScience, TheCulture, redditdev, programming, charity, netsec] whitelist_ids: [] # If you want to whitelist or blacklist specific multireddits, add them here +# Each one must be a list of 2 elements: username, multireddit +# Example: +# multi_blacklist: +# - [myusername, mymulti] +# - [someotheruser, theirmulti] multi_blacklist: [] multi_whitelist: [] diff --git a/shreddit/shreddit.yml.example b/shreddit/shreddit.yml.example index 498e98f..3fe276b 100644 --- a/shreddit/shreddit.yml.example +++ b/shreddit/shreddit.yml.example @@ -1,6 +1,7 @@ --- # Login details for Reddit. Fill out if you don't wish # to be prompted for a login every time you run Shreddit. +# If your username or password has characters that could cause problems, surround them in quotes. ### NOTE: This may be deprecated as you can specify in praw.ini instead username: password: @@ -39,6 +40,11 @@ whitelist: [AskScience, TheCulture, redditdev, programming, charity, netsec] whitelist_ids: [] # If you want to whitelist or blacklist specific multireddits, add them here +# Each one must be a list of 2 elements: username, multireddit +# Example: +# multi_blacklist: +# - [myusername, mymulti] +# - [someotheruser, theirmulti] multi_blacklist: [] multi_whitelist: []