qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: Eric Blake
Subject: Re: [Qemu-devel] [PATCH v2 05/23] error: Improve documentation around error_append_hint()
Date: Thu, 17 Dec 2015 12:53:06 -0700
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.3.0

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!

:)

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

Attachment: signature.asc
Description: OpenPGP digital signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]