Skip to content

Commit

Permalink
Clean up descriptions in compat-data.schema.json (#3100)
Browse files Browse the repository at this point in the history
* Clean up descriptions in compat-data.schema.json
Fixed a number of grammar errors and minor mistakes
in the descriptions of the fields in the schema. The
biggest fix is that the explanation of the
`partial_implementation` flag could have been interpreted
backward.

* Updates requested by Florian. A couple of odd line
wrapping issues fixed too.
  • Loading branch information
a2sheppy authored and Elchi3 committed Jan 7, 2019
1 parent 5e200d1 commit 97b72ea
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
16 changes: 11 additions & 5 deletions schemas/compat-data-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,13 +297,14 @@ In some cases features are named entirely differently and not just prefixed. Exa
Note that you can’t have both `prefix` and `alternative_name`.

#### `flags`
An optional array of objects indicating what kind of flags must be set for this feature to work. Usually this array will have one item, but there are cases where two or more flags can be required to activate a feature.
An optional array of objects describing flags that must be configured for this browser to support this feature. Usually this
array will have one item, but there are cases where two or more flags can be required to activate a feature.
An object in the `flags` array consists of three properties:
* `type` (mandatory): an enum that indicates the flag type:
* `preference` a flag the user can set (like in `about:config` in Firefox).
* `compile_flag` a flag to be set before compiling the browser.
* `runtime_flag` a flag to be set before starting the browser.
* `name` (mandatory): a `string` representing the flag or preference to modify.
* `name` (mandatory): a string giving the value which the specified flag must be set to for this feature to work.
* `value_to_set` (optional): representing the actual value to set the flag to.
It is a string, that may be converted to the right type
(that is `true` or `false` for Boolean value, or `4` for an integer value). It doesn't need to be enclosed in `<code>` tags.
Expand Down Expand Up @@ -347,10 +348,15 @@ It defaults to `false` (no interoperability problem expected).
If set to `true`, it is recommended to add a note indicating how it diverges from
the standard (implements an old version of the standard, for example).

A `boolean` value indicating whether or not the implementation of the sub-feature
deviates from the specification in a way that may cause compatibility problems. It
defaults to `false` (no interoperability problems expected). If set to `true`, it is
recommended that you add a note explaining how it diverges from the standard (such as
that it implements an old version of the standard, for example).

#### `notes`
An `array` of zero or more strings containing
additional information. If there is only one entry in the array,
the array can be a just a string. Example:
An `array` of zero or more strings containing additional information. If there is only one
entry in the array, the value of `notes` can simply be a string instead of an array. Example:

* Indicating a restriction:
```json
Expand Down
10 changes: 5 additions & 5 deletions schemas/compat-data.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
},
"flags": {
"type": "array",
"description": "An optional array of objects indicating what kind of flags must be set for this feature to work.",
"description": "An optional array of objects describing flags that must be configured for this browser to support this feature.",
"minItems": 1,
"items": {
"type": "object",
Expand All @@ -28,11 +28,11 @@
},
"name": {
"type": "string",
"description": "A string representing the flag or preference to modify."
"description": "A string giving the name of the flag or preference that must be configured."
},
"value_to_set": {
"type": "string",
"description": "A string representing the actual value to set the flag to."
"description": "A string giving the value which the specified flag must be set to for this feature to work."
}
},
"additionalProperties": false,
Expand All @@ -41,12 +41,12 @@
},
"partial_implementation": {
"type": "boolean",
"description": "A boolean value indicating whether or not the implementation of the sub-feature follows the current specification closely enough to not create major interoperability problems. It defaults to false (no interoperability problem expected). If set to true, it is recommended to add a note indicating how it diverges from the standard (implements an old version of the standard, for example)."
"description": "A boolean value indicating whether or not the implementation of the sub-feature deviates from the specification in a way that may cause compatibility problems. It defaults to false (no interoperability problems expected). If set to true, it is recommended that you add a note explaining how it diverges from the standard (such as that it implements an old version of the standard, for example)."
},
"version_added": { "$ref": "#/definitions/version_value" },
"version_removed": { "$ref": "#/definitions/version_value" },
"notes": {
"description": "An array of zero or more strings containing additional information.",
"description": "A string or array of strings containing additional information.",
"anyOf": [
{
"type": "string"
Expand Down

0 comments on commit 97b72ea

Please sign in to comment.