[R-pkg-devel] Is it possible to protect a word from the spell checker?

[Uwe Ligges]

On 07.03.2016 03:14, boB Rudis wrote:
> Is there a minimum length req for the single quote spell checker
> firewall? I've been putting 'API' in proper single quotes and it
> always gets flagged.

You do not need toout everything within qtuotes.
There are humans looking at the check result who know that the spell 
checker does not know some words. If a function foo() or a package 'pkg' 
are not typeset correctly (i.e. without parantheses or quotes, 
respectively), we see this quickly using the spellchecker. But the 
spellchecker is actually intended for spell checking. ;-)

Best,
Uwe Ligges

>
> On Sun, Mar 6, 2016 at 11:08 AM, Michael Dewey <lists at dewey.myzen.co.uk> wrote:
>> Thanks to all. I find it quite reassuring that even someone so steeped in R
>> is still finding new things to learn, it gives me hope.
>>
>>
>> On 02/03/2016 11:40, Uwe Ligges wrote:
>>>
>>> Indeed, from Writing R Extensions:
>>>
>>> "double quotes should be used for quotations (including titles of books
>>> and articles), and single quotes for non-English usage, including names
>>> of other packages and external software."
>>>
>>> Best,
>>> Uwe
>>>
>>>
>>>
>>>
>>> On 02.03.2016 09:53, Martin Maechler wrote:
>>>>>>>>>
>>>>>>>>> Hana Sevcikova <hanas at uw.edu>
>>>>>>>>>       on Tue, 1 Mar 2016 11:45:34 -0800 writes:
>>>>
>>>>
>>>>       > If it's in the DESCRIPTION file put the word into quotes.
>>>>       > Hana
>>>>
>>>> Indeed, thank you Hana!
>>>>
>>>> To add - embarrassingly I've only learned this about a week ago -
>>>> they need to be *single* quotes (as used 'here', they are also
>>>> called 'apostroph') and *not* double quotes.
>>>>
>>>> Martin
>>>>
>>>>       > On 01/03/2016 08:47, Michael Dewey wrote:
>>>>       >> The spell checker is correct they are not correctly spelled
>>>> English
>>>>       >> words but names. I searched the Writing R Extensions manual
>>>> but did not
>>>>       >> find any solution. I know it is only a NOTE not more serious.
>>>>
>>>> ______________________________________________
>>>> R-package-devel at r-project.org mailing list
>>>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>>>>
>>>
>>> ______________________________________________
>>> R-package-devel at r-project.org mailing list
>>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>>>
>>
>> --
>> Michael
>> http://www.dewey.myzen.co.uk/home.html
>>
>>
>> ______________________________________________
>> R-package-devel at r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-package-devel