Zergling_man/moment
Zergling_man/moment
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add helpful config comments

Browse Source 
I just spent half an hour debugging why some setting didn't work for me.
It was because I was putting it in Chat instead of Keys.Chat. This is
very confusing when you're making your own partial config override file.
I've added comments to the classes with identical names to hopefully
make this less confusing.
This commit is contained in:
Maze 2021-08-26 11:56:27 +02:00
parent 9a4ababd9a
commit 2433dba27e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/config/settings.py
View File

@ -288,7 +288,7 @@ class Keys:
# Quit Mirage # Quit Mirage
quit = [] quit = []
class Scrolling: class Scrolling: # Keys.Scrolling
# Pages and chat timeline scrolling # Pages and chat timeline scrolling
up = ["Alt+Up", "Alt+K"] up = ["Alt+Up", "Alt+K"]
down = ["Alt+Down", "Alt+J"] down = ["Alt+Down", "Alt+J"]
@ -322,7 +322,7 @@ class Keys:
previous = ["Alt+Shift+N"] previous = ["Alt+Shift+N"]
next = ["Alt+N"] next = ["Alt+N"]
class AtIndex: class AtIndex: # Accounts.AtIndex
# Switch to the first room of the account number X in the list. # Switch to the first room of the account number X in the list.
# Each property is a list of keybinds for the account number X. # Each property is a list of keybinds for the account number X.
# Numbers beyond the default ones can be added. # Numbers beyond the default ones can be added.
@ -373,7 +373,7 @@ class Keys:
oldest_highlight = ["Ctrl+Shift+M"] oldest_highlight = ["Ctrl+Shift+M"]
latest_highlight = ["Ctrl+M"] latest_highlight = ["Ctrl+M"]
class AtIndex: class AtIndex: # Rooms.AtIndex
# Switch to room number X in the current account. # Switch to room number X in the current account.
# Each property is a list of keybinds for the room number X: # Each property is a list of keybinds for the room number X:
# Numbers beyond the default ones can be added. # Numbers beyond the default ones can be added.
@ -400,7 +400,7 @@ class Keys:
# which account should be targeted as "<userId> <roomId>": # which account should be targeted as "<userId> <roomId>":
"@account:example.org !roomID:example.org" = [] "@account:example.org !roomID:example.org" = []
class Chat: class Chat: # Keys.Chat
# Keybinds specific to the current chat page. # Keybinds specific to the current chat page.
# Focus the right room pane. If the pane is currently showing the # Focus the right room pane. If the pane is currently showing the