Skip to content

Commit 9c1add0

Browse files
committed
chore(schemas): replace e.g. with for example
1 parent 3db0f7b commit 9c1add0

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

schemas/browsers-schema.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The browser JSON schema
22

3-
This document helps you to understand the structure of the browser (and JavaScript runtime) data in BCD, including the browser type, a display-friendly name, release data and more. Each browser is defined by a unique identifier (e.g. `firefox` or `chrome_android`). Each browser JSON file describes exactly one browser.
3+
This document helps you to understand the structure of the browser (and JavaScript runtime) data in BCD, including the browser type, a display-friendly name, release data and more. Each browser is defined by a unique identifier (for example `firefox` or `chrome_android`). Each browser JSON file describes exactly one browser.
44

55
Note: while NodeJS and Deno are JavaScript runtimes and not browsers, data for them is placed in `browsers`, and are included whenever we use the term "browsers".
66

@@ -56,7 +56,7 @@ A required boolean indicating whether the browser supports web extensions. A `tr
5656

5757
### `pref_url`
5858

59-
An optional string containing the URL of the page where feature flags can be changed (e.g. `"about:config"` for Firefox or `"chrome://flags"` for Chrome).
59+
An optional string containing the URL of the page where feature flags can be changed (for example `"about:config"` for Firefox or `"chrome://flags"` for Chrome).
6060

6161
### `preview_name`
6262

@@ -78,7 +78,7 @@ The `releases` object contains data regarding the browsers' releases, using the
7878

7979
- An optional `release_notes` property which points to release notes. It needs to be a valid URL.
8080

81-
- An optional `engine` property which is the name of the browser's engine. Valid values are `"Blink"`, `"EdgeHTML"`, `"Gecko"`, `"Presto"`, `"Trident"`, `"WebKit"`, and `"V8"`. This property is placed on the individual release as a browser may switch to a different engine (e.g. Microsoft Edge switched to Chrome as its base engine). If `engine` is specified, `engine_version` must also be provided.
81+
- An optional `engine` property which is the name of the browser's engine. Valid values are `"Blink"`, `"EdgeHTML"`, `"Gecko"`, `"Presto"`, `"Trident"`, `"WebKit"`, and `"V8"`. This property is placed on the individual release as a browser may switch to a different engine (for example Microsoft Edge switched to Chrome as its base engine). If `engine` is specified, `engine_version` must also be provided.
8282

8383
- An optional `engine_version` property indicating the engine version used in this release. Required when `engine` is specified.
8484

schemas/compat-data-schema.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The JSON files contain [feature identifiers](#features), which are relevant for
4040

4141
### Feature hierarchies
4242

43-
Each feature is identified by a unique hierarchy of strings, e.g. the `text-align` property is identified by `css.properties.text-align`.
43+
Each feature is identified by a unique hierarchy of strings, for example the `text-align` property is identified by `css.properties.text-align`.
4444

4545
In the JSON file it looks like this:
4646

@@ -179,10 +179,10 @@ The `__compat` object consists of the following:
179179
This property may be formatted using Markdown, see the rules for `notes`.
180180

181181
- An optional `mdn_url` property which **points to an MDN reference page documenting the feature**.
182-
It needs to be a valid URL, and should be the language-neutral URL (e.g. use `https://developer.mozilla.org/docs/Web/CSS/text-align` instead of `https://developer.mozilla.org/en-US/docs/Web/CSS/text-align`).
182+
It needs to be a valid URL, and should be the language-neutral URL (for example use `https://developer.mozilla.org/docs/Web/CSS/text-align` instead of `https://developer.mozilla.org/en-US/docs/Web/CSS/text-align`).
183183

184184
- An optional `spec_url` property as a URL or an array of URLs, each of which is for a specific part of a specification in which this feature is defined.
185-
Each URL must contain a fragment identifier (e.g. `https://tc39.es/proposal-promise-allSettled/#sec-promise.allsettled`) or match one of the regular-expression pattern given in the JSON Schema file.
185+
Each URL must contain a fragment identifier (for example `https://tc39.es/proposal-promise-allSettled/#sec-promise.allsettled`) or match one of the regular-expression pattern given in the JSON Schema file.
186186
Each URL must link to a specification published by a standards body or a formal proposal that may lead to such publication.
187187

188188
- An optional `tags` property to assign tags to the feature.
@@ -494,4 +494,4 @@ The mandatory status property contains information about stability of the featur
494494

495495
### Localization
496496

497-
We are planning to localize some of this data (e.g. notes, descriptions). At this point we haven't decided how or when we are going to do that. See [issue 114](https://github.com/mdn/browser-compat-data/issues/114) for more information.
497+
We are planning to localize some of this data (for example notes, descriptions). At this point we haven't decided how or when we are going to do that. See [issue 114](https://github.com/mdn/browser-compat-data/issues/114) for more information.

schemas/public.schema.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ Below is a simplified example of the published data:
6969

7070
The `__meta` object is a required property containing metadata about the published data. It has two required properties:
7171

72-
- `version`: a string containing the package version (e.g. `"6.0.0"`).
73-
- `timestamp`: a string containing the ISO 8601 date-time when the data was built (e.g. `"2024-01-15T00:00:00.000Z"`).
72+
- `version`: a string containing the package version (for example `"6.0.0"`).
73+
- `timestamp`: a string containing the ISO 8601 date-time when the data was built (for example `"2024-01-15T00:00:00.000Z"`).
7474

7575
### `browsers`
7676

@@ -110,14 +110,14 @@ The `__compat` object describes a feature's compatibility data. It consists of t
110110
In the published data, this property is formatted as HTML.
111111

112112
- An optional `mdn_url` property which **points to an MDN reference page documenting the feature**.
113-
It needs to be a valid URL, and should be the language-neutral URL (e.g. use `https://developer.mozilla.org/docs/Web/CSS/text-align` instead of `https://developer.mozilla.org/en-US/docs/Web/CSS/text-align`).
113+
It needs to be a valid URL, and should be the language-neutral URL (for example use `https://developer.mozilla.org/docs/Web/CSS/text-align` instead of `https://developer.mozilla.org/en-US/docs/Web/CSS/text-align`).
114114

115115
- An optional `spec_url` property as a URL or an array of URLs, each of which is for a specific part of a specification in which this feature is defined.
116116
Each URL must contain a fragment identifier.
117117

118118
- An optional `tags` property to assign tags to the feature.
119119

120-
- A mandatory `source_file` property containing the path to the source file that defines this feature, relative to the repository root (e.g. `"api/AbortController.json"`). This is automatically generated at build time.
120+
- A mandatory `source_file` property containing the path to the source file that defines this feature, relative to the repository root (for example `"api/AbortController.json"`). This is automatically generated at build time.
121121

122122
#### The `support_statement` object
123123

0 commit comments

Comments
 (0)