From 8a6114c3c45d2c59c859fff0e3d61adb60005e9f Mon Sep 17 00:00:00 2001
From: Nils K <24257556+septatrix@users.noreply.github.com>
Date: Thu, 25 Apr 2024 00:58:04 +0200
Subject: [PATCH] Fix documentation of COG_PLATFORM_DRM_VIDEO_MODE

The docs stated that it accept a refresh rate which is not true
---
 docs/platform-drm.md | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/docs/platform-drm.md b/docs/platform-drm.md
index 4f95a313..d62394e1 100644
--- a/docs/platform-drm.md
+++ b/docs/platform-drm.md
@@ -74,13 +74,14 @@ DRM plug-in operates:
 | `COG_PLATFORM_DRM_CURSOR` | string | *(unset)* |
 
 By default the preferred mode for the first found connected output is used
-(if available), otherwise the mode with most resolution.
+(if available), otherwise the mode with highest resolution.
 Setting `COG_PLATFORM_DRM_VIDEO_MODE` instructs the plug-in to pick a
 particular video mode, while `COG_PLATFORM_DRM_MODE_MAX` can be used to
-limit which modes are considered. Mode strings are formatted as `WxH@R`
-(`W`idth and `H`eight in pixels, `R`efresh rate in Hertz), for example
-`1920x1080@60` for a typical Full-HD mode. The `@R` part can be omitted
-in `COG_PLATFORM_DRM_MODE_MAX`.
+limit which modes are considered. `COG_PLATFORM_DRM_VIDEO_MODE` accepts
+mode strings in the format `WxR` (`W`idth and `H`eight in pixels).
+`COG_PLATFORM_DRM_MODE_MAX` additionally accepts mode strings with
+a refresh rate in the format `WxH@R`.
+for example `1920x1080@60` for a typical Full-HD mode.
 
 Setting `COG_PLATFORM_DRM_CURSOR` to a non-empty string enables showing
 the mouse cursor pointer.