Skip to content
Snippets Groups Projects
Unverified Commit b48bd3a8 authored by Bastian Triller's avatar Bastian Triller Committed by GitHub
Browse files

Fix typos (#1458)

Fix typos and manufacturer's position in device type's slug description.
Add link to elevation-images folder.
parent 4ac4c79a
No related branches found
No related tags found
No related merge requests found
...@@ -23,7 +23,7 @@ Each definition **must** include at minimum the following fields: ...@@ -23,7 +23,7 @@ Each definition **must** include at minimum the following fields:
- `model`: The model number of the device type. This must be unique per manufacturer. - `model`: The model number of the device type. This must be unique per manufacturer.
- Type: String - Type: String
- `slug`: A URL-friendly representation of the model number. Like the model number, this must be unique per - `slug`: A URL-friendly representation of the model number. Like the model number, this must be unique per
manufacturer. All slugs should have the manufacturers name appended to it with a dash, please see the example below. manufacturer. All slugs should have the manufacturers name prepended to it with a dash, please see the example below.
- Type: String - Type: String
- Pattern: `"^[-a-zA-Z0-9_]+$"`. Must match the following characters: `-`, `_`, Uppercase or Lowercase `a` to `z`, Numbers `0` to `9`. - Pattern: `"^[-a-zA-Z0-9_]+$"`. Must match the following characters: `-`, `_`, Uppercase or Lowercase `a` to `z`, Numbers `0` to `9`.
...@@ -55,11 +55,11 @@ The following fields may **optionally** be declared: ...@@ -55,11 +55,11 @@ The following fields may **optionally** be declared:
- `side-to-rear` - `side-to-rear`
- `passive` - `passive`
> :test_tube: **Example**: `airflow: side-to-rear` > :test_tube: **Example**: `airflow: side-to-rear`
- `front_image`: Indicates that this device has a front elevation image within the elevation-imgaes folder. (**Default: None**) - `front_image`: Indicates that this device has a front elevation image within the [elevation-images](elevation-images/) folder. (**Default: None**)
- NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.front.<acceptable_format> - NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.front.<acceptable_format>
- Type: Boolean - Type: Boolean
> :test_tube: **Example**: `front_image: True` > :test_tube: **Example**: `front_image: True`
- `rear_image`: Indicates that this device has a rear elevation image within the elevation-imgaes folder. (**Default: None**) - `rear_image`: Indicates that this device has a rear elevation image within the [elevation-images](elevation-images/) folder. (**Default: None**)
- NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.rear.<acceptable_format> - NOTE: The elevation images folder requires the same folder name as this device. The file name must also adhere to <VALUE_IN_SLUG>.rear.<acceptable_format>
- Type: Boolean - Type: Boolean
> :test_tube: **Example**: `rear_image: True` > :test_tube: **Example**: `rear_image: True`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment