Skip to content

Commit 77fa93c

Browse files
nicopopnicopop
committed
Schema descriptions tweaks 1th pass
1 parent bae6678 commit 77fa93c

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

‎schemas/Manual.options.schema.json‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
"type": "object",
1515
"patternProperties": {
1616
"^_.*$": {
17-
"description": "A commented out override Option",
17+
"description": "A commented out Option Modification",
1818
"allOf": [{"$ref": "#/definitions/OptionBase"}],
1919
"properties": {
2020
"type": {"$ref": "#/definitions/OptionCore/properties"}
2121
}
2222
},
2323
"^.*$": {
24-
"description": "An Modification of a Core Option of Manual",
24+
"description": "A Modification of a Core Option of Manual",
2525
"$ref": "#/definitions/OptionCore"
2626
}
2727
}
@@ -38,7 +38,7 @@
3838
}
3939
},
4040
"^.*$": {
41-
"description": "An Option for your World, the possible Parameters depend on the type of option you set in \"type\"\nToggle: \"default\" \n Let the player choose between yes or no \nChoice: \"value\", \"aliases\", \"default\" and \"allow_custom_value\" \n Let the player pick from a list of values \nRange: \"range_start\", \"range_end\", \"default\" and an optional \"values\"\nAllow the player to specify a number between 'start' and 'end'",
41+
"description": "An Option for your World, the possible properties depend on the type of option you set in \"type\"\nToggle: \"default\"* \n Let the player choose between yes or no \nChoice: \"values\"*, \"aliases\", \"default\" and \"allow_custom_value\" \n Let the player pick from a list of values \nRange: \"range_start\", \"range_end\", \"default\" and an \"values\"\nAllow the player to specify a number between 'start' and 'end'",
4242
"$ref": "#/definitions/OptionUser"
4343
}
4444
}
@@ -51,16 +51,16 @@
5151
"type": "object",
5252
"properties": {
5353
"display_name": {
54-
"description": "The name shown on the webhost.",
54+
"description": "(Optional) The name shown on the webhost",
5555
"type": "string"
5656
},
5757
"description": {
58-
"description": "long description of what this option is for(is shown on hover on the webhost)",
58+
"description": "(Optional) A long description of what this option is for(is shown on hover on the webhost)",
5959
"type": ["array", "string"],
6060
"items": {"type": "string"}
6161
},
6262
"rich_text_doc": {
63-
"description": "(Optional) support for HTML generated from the standard Python reStructuredText format for your description. \nfor more info: https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/options%20api.md#option-documentation",
63+
"description": "(Optional) Enables support for HTML generated from the standard Python reStructuredText format for your description. \nfor more info: https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/options%20api.md#option-documentation",
6464
"type": "boolean",
6565
"default": false
6666
},
@@ -137,32 +137,33 @@
137137
},
138138

139139
"Type": {
140-
"description": "The type of this options, check the official Archipelago docs for the options types here: \nhttps://github.com/ArchipelagoMW/Archipelago/blob/main/docs/options%20api.md#basic-option-classes",
140+
"description": "The type of this options. \nHover your mouse on any uncommented option's name to get a list of valid types for Manual options and a short description for each",
141141
"type": "string",
142142
"enum": ["Toggle", "Choice", "Range"]
143143
},
144144
"ChoiceValue": {
145-
"description": "A dict of possible values in the format 'name':int \nthe default option is, by default the one with 0 as value",
145+
"description": "A dictionary of possible values in the format {\"name\":0, \"other name\":2} \nUnless the default is changed, there need to be a defined value of 0.",
146146
"type":"object",
147147
"patternProperties": {
148148
"^.*$": {
149149
"description": "An int value this option can have",
150150
"type": "integer"
151151
}
152152
}
153+
153154
},
154155
"ChoiceAlias": {
155-
"description": "A dict of possible values in the format 'name':int/the name of a value from 'values'",
156+
"description": "(Optional) A dictionary of aliases in the format {\"name\":0, \"other name\":2} or {\"name\":\"name of another value/alias\"}",
156157
"type": "object",
157158
"patternProperties": {
158159
"^.*$": {
159-
"description": "An alias for a value declared in 'values'",
160+
"description": "An alias for one of this option's value",
160161
"type": ["integer", "string"]
161162
}
162163
}
163164
},
164165
"ChoiceAllowCustomValue": {
165-
"description": "Allow the user to set their own custom string Value",
166+
"description": "(Optional) Allow the user to set their own custom string Value",
166167
"type": "boolean",
167168
"default": false
168169
},
@@ -188,25 +189,25 @@
188189
"examples": [{"test": 1}]
189190
},
190191
"SpecialRangeNames": {
191-
"description": "(Optional) A Special Dictionary in the format 'name':int of named values for this range \nAll names need to be lowercase",
192+
"description": "(Optional) A Special Dictionary in the format {\"name\":0, \"other name\":2} of named values for this range \nAll names need to be lowercase",
192193
"allOf": [{"$ref": "#/definitions/SpecialRangeNames_base"}]
193194
},
194195
"SpecialRangeNames_core": {
195-
"description": "(Optional) A Special Dictionary in the format 'name':int of named values for this range \nAll names need to be lowercase\nForbidden for Options of type Choice",
196+
"description": "(Optional) A Special Dictionary in the format {\"name\":0, \"other name\":2} of named values for this range \nAll names need to be lowercase \nForbidden for Options of type Choice",
196197
"allOf": [{"$ref": "#/definitions/SpecialRangeNames_base"}]
197198
},
198199
"DefaultInt": {
199-
"description": "the default integer value of this option",
200+
"description": "(Optional) The default integer value of this option",
200201
"type": "integer",
201202
"default": 0
202203
},
203204
"DefaultToggle": {
204-
"description": "the default value of this Toggle",
205+
"description": "The default value of this Toggle",
205206
"type": "boolean",
206207
"default": false
207208
},
208209
"DefaultCore": {
209-
"description": "the default value of this option, its type depend on the type of the option you are overriding",
210+
"description": "The default value of this option, its type depend on the type of the option you are overriding",
210211
"type": ["integer", "boolean"]
211212
},
212213
"comment": {

0 commit comments

Comments
 (0)