docs: Improve documentation for all options (#56)
* 💬 Update details for all options
* I'm as consistent as rocks
* Clearer
This commit is contained in:
parent
29ddf87284
commit
6ae9d98730
1 changed files with 10 additions and 10 deletions
20
package.json
20
package.json
|
@ -53,47 +53,47 @@
|
|||
"discord.enabled": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "Controls if Discord Presence is active"
|
||||
"description": "Controls if the Discord Presence should show across all workspaces"
|
||||
},
|
||||
"discord.reconnectThreshold": {
|
||||
"type": "number",
|
||||
"default": 20,
|
||||
"description": "Decides how often a reconnect attempt should be made before stopping"
|
||||
"description": "Decides how many reconnect attempts should be made before stopping"
|
||||
},
|
||||
"discord.detailsEditing": {
|
||||
"type": "string",
|
||||
"default": "Editing {filename}",
|
||||
"description": "Custom string for the details section of the rich presence\nIf this is set to '{null}', it will be replaced with an empty space"
|
||||
"description": "Custom string for the details section of the rich presence\n\t- '{null}' will be replaced with an empty space.\n\t- '{filename}' will be replaced with the current file name.\n\t- '{workspace}' will be replaced with the current workspace name, if any."
|
||||
},
|
||||
"discord.detailsDebugging": {
|
||||
"type": "string",
|
||||
"default": "Editing {filename}",
|
||||
"description": "Custom string for the details section of the rich presence when debugging\nIf this is set to '{null}', it will be replaced with an empty space"
|
||||
"description": "Custom string for the details section of the rich presence when debugging\n\t- '{null}' will be replaced with an empty space.\n\t- '{filename}' will be replaced with the current file name.\n\t- '{workspace}' will be replaced with the current workspace name, if any."
|
||||
},
|
||||
"discord.detailsIdle": {
|
||||
"type": "string",
|
||||
"default": "Idling",
|
||||
"description": "Custom string for the details section of the rich presence when idling"
|
||||
"description": "Custom string for the details section of the rich presence when idling\n\t- '{null}' will be replaced with an empty space."
|
||||
},
|
||||
"discord.lowerDetailsEditing": {
|
||||
"type": "string",
|
||||
"default": "Workspace: {workspace}",
|
||||
"description": "Custom string for the state section of the rich presence\nIf this is set to '{null}', it will be replaced with an empty space"
|
||||
"description": "Custom string for the state section of the rich presence\n\t- '{null}' will be replaced with an empty space.\n\t- '{filename}' will be replaced with the current file name.\n\t- '{workspace}' will be replaced with the current workspace name, if any."
|
||||
},
|
||||
"discord.lowerDetailsDebugging": {
|
||||
"type": "string",
|
||||
"default": "Debugging: {workspace}",
|
||||
"description": "Custom string for the state section of the rich presence when debugging\nIf this is set to '{null}', it will be replaced with an empty space"
|
||||
"description": "Custom string for the state section of the rich presence when debugging\n\t- '{null}' will be replaced with an empty space.\n\t- '{filename}' will be replaced with the current file name.\n\t- '{workspace}' will be replaced with the current workspace name, if any."
|
||||
},
|
||||
"discord.lowerDetailsIdle": {
|
||||
"type": "string",
|
||||
"default": "Idling",
|
||||
"description": "Custom string for the state section of the rich presence when idling"
|
||||
"description": "Custom string for the state section of the rich presence when idling\n\t- '{null}' will be replaced with an empty space."
|
||||
},
|
||||
"discord.lowerDetailsNotFound": {
|
||||
"type": "string",
|
||||
"default": "No workspace.",
|
||||
"description": "Custom string for the state section of the rich presence when no workspace is found"
|
||||
"description": "Custom string for the state section of the rich presence when no workspace is found.\nIf set to '{null}', this will be an empty space."
|
||||
},
|
||||
"discord.largeImage": {
|
||||
"type": "string",
|
||||
|
@ -108,7 +108,7 @@
|
|||
"discord.smallImage": {
|
||||
"type": "string",
|
||||
"default": "{appname}",
|
||||
"description": "Custom string for the smallImageText section of the rich presence"
|
||||
"description": "Custom string for the smallImageText section of the rich presence\n\t- '{appname}' will get replaced with the current Visual Studio Code version."
|
||||
},
|
||||
"discord.silent": {
|
||||
"type": "boolean",
|
||||
|
|
Loading…
Reference in a new issue