From f71e6c3cfa6397cfa0fd53017ea77a4cbfca9cbd Mon Sep 17 00:00:00 2001 From: Nicolas Munnich Date: Mon, 5 Aug 2024 12:59:13 +0200 Subject: [PATCH] It's always prettier. --- .../hardware-metadata-files/hardware-metadata-files.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx b/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx index d9b03ba9..55f7d3a5 100644 --- a/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx +++ b/docs/docs/development/hardware-metadata-files/hardware-metadata-files.mdx @@ -78,7 +78,7 @@ url: https://github.com/foostan/crkbd/ The `module` property has three children: - `url` pointing to the repository containing an appropriate module, if the type of the metadata demands it. This can be the same as `url`, and can be shared with other metadata files e.g. if multiple shields are defined in one module. --`commit` specifying a commit from the `url` repository which should be used. This property **cannot** point to `HEAD`, though it can point to the commit that `HEAD` is set to at the time of writing. This is to help prevent sudden breaking or malicious changes to remote repositories from affecting the users and tools of `zmk-modules`. +- `commit` specifying a commit from the `url` repository which should be used. This property **cannot** point to `HEAD`, though it can point to the commit that `HEAD` is set to at the time of writing. This is to help prevent sudden breaking or malicious changes to remote repositories from affecting the users and tools of `zmk-modules`. - `outdated` is an optional child. If it is not present, it is assumed that the module is up-to-date with ZMK's `HEAD`. If it is present, then it points to the most recently working ZMK commit. ```yaml