Re: [Qemu-devel] [PATCH v2 05/23] error: Improve documentation around error_append_hint()

[Markus Armbruster]

Eric Blake <address@hidden> writes:

> On 12/17/2015 12:00 PM, Markus Armbruster wrote:
>
>>>>>> @@ -128,6 +138,7 @@ ErrorClass error_get_class(const Error *err);
>>>>>>   * If @errp is anything else, address@hidden must be NULL.
>>>>>>   * The new error's class is ERROR_CLASS_GENERIC_ERROR, and its
>>>>>>   * human-readable error message is made from printf-style @fmt, ...
>>>>>> + * The resulting message should not contain newlines.
>>>>>
>>>>> Should we also discourage trailing punctuation?
>>>>
>>>> Yes.  How to best phrase it?
>>>
>>> Maybe:
>>>
>>> The resulting message should be a single phrase, with no newline or
>>> trailing punctuation.
>> 
>> What about ending the message with an exclamation mark?
>
> Very few current users do that! An exclamation mark is still trailing
> punctuation! And I don't like shouting at users!
>
> :)

Okay, okay, I applied it %-)