Re: Introducing thread-safe Tramp

[Stephen Berman]

On Tue, 07 Aug 2018 17:02:41 +0200 Robert Pluim <address@hidden> wrote:

> Stephen Berman <address@hidden> writes:
>
>> On Tue, 07 Aug 2018 16:20:54 +0200 Michael Albinus <address@hidden> wrote:
>>
>>> Filipp Gunbin <address@hidden> writes:
>>>
>>> Hi Filipp,
>>>
>>> Thanks for your comments!
>>>
>>>> files.texi:
>>>>
>>>> +If this option is @code{nil} (the default), visiting a file is
>>>> +performed synchronously.  A regexp value let files, which name matches
>>>>                                           ^^^
>>>>                                           lets
>>                                                       ^ and no comma here
>>
>>>> +(defvar universal-async-argument nil
>>>> +  "Non-nil indicates a command to run asynchronously when called 
>>>> interactively.
>>>>                       ^^^^^^^^^^^^
>>>>                       that a command should?
>>>
>>> Not "should". It is just a hint that a user wishes the next command to
>>> run asynchronously. This could be prefixed for *every* command; whether
>>> that command cares about the indication is up to the command itself.
>>>
>>> If you mean just better English - OK. But the first sentence of a
>>> docstring must fit into one line.
>>
>> How about this: 
>> "Non-nil means the next interactively called command runs asynchronously."
>> Or since commands are really interactively called functions, just this:
>> "Non-nil means the next command runs asynchronously."
>
> "Non-nil means the next command is requested to run asynchronously."
>
> The command in question might not have async support.

Good point.  Or, since passive is discouraged in the Emacs doc:

"Non-nil means the next command runs asynchronously, if possible."

Steve Berman