From dbbe8a2da5865711381b6ebe4b51b3e1844234bd Mon Sep 17 00:00:00 2001 From: ridiculousfish Date: Wed, 22 Jan 2020 11:51:40 -0800 Subject: [PATCH] Clarify expand_result_t comments --- src/expand.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/expand.h b/src/expand.h index 678afd1af..5b396c711 100644 --- a/src/expand.h +++ b/src/expand.h @@ -99,13 +99,14 @@ enum : wchar_t { EXPAND_SENTINAL }; -/// These are the possible return values for expand_string. Note how zero value is the only error. +/// These are the possible return values for expand_string. enum class expand_result_t { - /// Error + /// There was a syntax error, for example, unmatched braces. error, - /// Ok + /// Expansion succeeded. ok, - /// Ok, a wildcard in the string matched no files. + /// Expansion succeeded, but a wildcard in the string matched no files, + /// so the output is empty. wildcard_no_match, };