From b036d0bbd6d2af3727946886f8ad82ba8b25a959 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Sat, 2 Sep 2006 13:40:41 +0000 Subject: [PATCH] clarify error message Original commit message from CVS: clarify error message --- gst/gsterror.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/gst/gsterror.c b/gst/gsterror.c index a4f75a0..7423e63 100644 --- a/gst/gsterror.c +++ b/gst/gsterror.c @@ -82,7 +82,11 @@ * parentheses. * If you do supply a custom message, it should be * marked for translation. The message should start with a capital - * and end with a period. + * and end with a period. The message should describe the error in short, + * in a human-readable form, and without any complex technical terms. + * A user interface will present this message as the first thing a user + * sees. Details, technical info, ... should go in the debug string. + * * The debug string can be as you like. Again, use (NULL) * if there's nothing to add - file and line number will still be * passed. #GST_ERROR_SYSTEM can be used as a shortcut to give -- 2.7.4