From 30926c1f106eff0847f14635c552048adf3850d5 Mon Sep 17 00:00:00 2001 From: Sasha Koshka Date: Sun, 20 Oct 2024 13:39:11 -0400 Subject: [PATCH] Improve doc comment on format::desktop_entry::strerror --- format/desktop_entry/error.ha | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/format/desktop_entry/error.ha b/format/desktop_entry/error.ha index 99f63f1..ff00992 100644 --- a/format/desktop_entry/error.ha +++ b/format/desktop_entry/error.ha @@ -24,7 +24,8 @@ export type invalid_ascii = !void; // Returned when an invalid escape sequence was enctountered while parsing. export type invalid_escape = !void; -// Converts a desktop entry [[error]] into a user-friendly string. +// Returns a user-friendly representation of [[error]]. The result may be +// statically allocated. export fn strerror(err: error) str = match (err) { case invalid_group_header => yield "invalid group header"; case invalid_entry => yield "invalid entry";