Improves config files self documentation

pull/75/head
Scott 8 years ago
parent 4c78f404e2
commit 6cb808c403

@ -1,6 +1,7 @@
--- ---
# Login details for Reddit. Fill out if you don't wish # Login details for Reddit. Fill out if you don't wish
# to be prompted for a login every time you run Shreddit. # 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 ### NOTE: This may be deprecated as you can specify in praw.ini instead
username: username:
password: password:
@ -39,6 +40,11 @@ whitelist: [AskScience, TheCulture, redditdev, programming, charity, netsec]
whitelist_ids: [] whitelist_ids: []
# If you want to whitelist or blacklist specific multireddits, add them here # 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_blacklist: []
multi_whitelist: [] multi_whitelist: []

@ -1,6 +1,7 @@
--- ---
# Login details for Reddit. Fill out if you don't wish # Login details for Reddit. Fill out if you don't wish
# to be prompted for a login every time you run Shreddit. # 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 ### NOTE: This may be deprecated as you can specify in praw.ini instead
username: username:
password: password:
@ -39,6 +40,11 @@ whitelist: [AskScience, TheCulture, redditdev, programming, charity, netsec]
whitelist_ids: [] whitelist_ids: []
# If you want to whitelist or blacklist specific multireddits, add them here # 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_blacklist: []
multi_whitelist: [] multi_whitelist: []

Loading…
Cancel
Save