Tiny documentation error for ?options (PR#8633)

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Tiny documentation error for ?options (PR#8633)

pinard

Hi, people.  The output produced by "?options" contains:

     'expressions': sets a limit on the number of nested expressions
          that will be evaluated.  Valid values are 25...500000 with
          default 1000.  [...]

and a bit further down:

     The 'factory-fresh' default settings of some of these options are
       [...]
       'expressions'          '5000'

Is there a distinction between "default" and "factory-fresh default"?  
If not, then 1000 might be the correct value instead of 5000, as 1000 is
contained in the list returned by R when given "options('expressions')".

--please do not edit the information below--

Version:
 platform = i686-pc-linux-gnu
 arch = i686
 os = linux-gnu
 system = i686, linux-gnu
 status =
 major = 2
 minor = 2.1
 year = 2005
 month = 12
 day = 20
 svn rev = 36812
 language = R

Locale:
LC_CTYPE=fr_CA.UTF-8;LC_NUMERIC=C;LC_TIME=fr_CA.UTF-8;LC_COLLATE=fr_CA.UTF-8;LC_MONETARY=fr_CA.UTF-8;LC_MESSAGES=fr_CA.UTF-8;LC_PAPER=C;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=C;LC_IDENTIFICATION=C

Search Path:
 .GlobalEnv, package:methods, package:stats, package:graphics, package:utils, package:datasets, fp.etc, package:grDevices, Autoloads, package:base

______________________________________________
[hidden email] mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Reply | Threaded
Open this post in threaded view
|

Re: Tiny documentation error for ?options (PR#8633)

Brian Ripley
This is already corrected in the the development version of R: see

https://svn.r-project.org/R/trunk/src/library/base/man/options.Rd

(The FAQ does suggest you check there before sending a bug report.)

It is a question of defaults being changed frequently (because C stack
overflow was occuring on some platforms) and the documentation being
behind.

On Thu, 23 Feb 2006, [hidden email] wrote:

>
> Hi, people.  The output produced by "?options" contains:
>
>     'expressions': sets a limit on the number of nested expressions
>          that will be evaluated.  Valid values are 25...500000 with
>          default 1000.  [...]
>
> and a bit further down:
>
>     The 'factory-fresh' default settings of some of these options are
>       [...]
>       'expressions'          '5000'
>
> Is there a distinction between "default" and "factory-fresh default"?
> If not, then 1000 might be the correct value instead of 5000, as 1000 is
> contained in the list returned by R when given "options('expressions')".
>
> --please do not edit the information below--
>
> Version:
> platform = i686-pc-linux-gnu
> arch = i686
> os = linux-gnu
> system = i686, linux-gnu
> status =
> major = 2
> minor = 2.1
> year = 2005
> month = 12
> day = 20
> svn rev = 36812
> language = R
>
> Locale:
> LC_CTYPE=fr_CA.UTF-8;LC_NUMERIC=C;LC_TIME=fr_CA.UTF-8;LC_COLLATE=fr_CA.UTF-8;LC_MONETARY=fr_CA.UTF-8;LC_MESSAGES=fr_CA.UTF-8;LC_PAPER=C;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=C;LC_IDENTIFICATION=C
>
> Search Path:
> .GlobalEnv, package:methods, package:stats, package:graphics, package:utils, package:datasets, fp.etc, package:grDevices, Autoloads, package:base
>
> ______________________________________________
> [hidden email] mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>
>

--
Brian D. Ripley,                  [hidden email]
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272866 (PA)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595

______________________________________________
[hidden email] mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel
Reply | Threaded
Open this post in threaded view
|

Re: Tiny documentation error for ?options (PR#8633)

François Pinard
[Brian Ripley]
>This is already corrected in the the development version of R:

Good, thanks!

P.S. - More generally, huge thanks to all developers of this impressive
R system.  I have an idea of the constant courage and long dedication it
takes for reaching the usability and maturity R already has.

>(The FAQ does suggest you check there before sending a bug report.)

Yes, I know (and even checked the FAQ first, as I could quickly do it).  
I had to choose between putting more time in research that I had at my
disposal, and not sending a report.  If I did the wrong choice, just
tell me, and I'll merely refrain in similar circumstances.

I may be a very patient nit-picker, and while this is advantageous for
a system, it is sometimes irritating for those maintaining it.


[Reminder of original message follows]

>It is a question of defaults being changed frequently (because C stack
>overflow was occuring on some platforms) and the documentation being
>behind.

>On Thu, 23 Feb 2006, [hidden email] wrote:


>>Hi, people.  The output produced by "?options" contains:

>>     'expressions': sets a limit on the number of nested expressions
>>          that will be evaluated.  Valid values are 25...500000 with
>>          default 1000.  [...]

>>and a bit further down:

>>     The 'factory-fresh' default settings of some of these options are
>>       [...]
>>       'expressions'          '5000'

>>Is there a distinction between "default" and "factory-fresh default"?
>>If not, then 1000 might be the correct value instead of 5000, as 1000 is
>>contained in the list returned by R when given "options('expressions')".

>>--please do not edit the information below--

>>Version:
>>platform = i686-pc-linux-gnu
>>arch = i686
>>os = linux-gnu
>>system = i686, linux-gnu
>>status =
>>major = 2
>>minor = 2.1
>>year = 2005
>>month = 12
>>day = 20
>>svn rev = 36812
>>language = R

>>Locale:
>>LC_CTYPE=fr_CA.UTF-8;LC_NUMERIC=C;LC_TIME=fr_CA.UTF-8;LC_COLLATE=fr_CA.UTF-8;LC_MONETARY=fr_CA.UTF-8;LC_MESSAGES=fr_CA.UTF-8;LC_PAPER=C;LC_NAME=C;LC_ADDRESS=C;LC_TELEPHONE=C;LC_MEASUREMENT=C;LC_IDENTIFICATION=C

>>Search Path:
>>.GlobalEnv, package:methods, package:stats, package:graphics,
>>package:utils, package:datasets, fp.etc, package:grDevices, Autoloads,
>>package:base

>>______________________________________________
>>[hidden email] mailing list
>>https://stat.ethz.ch/mailman/listinfo/r-devel



>--
>Brian D. Ripley,                  [hidden email]
>Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
>University of Oxford,             Tel:  +44 1865 272861 (self)
>1 South Parks Road,                     +44 1865 272866 (PA)
>Oxford OX1 3TG, UK                Fax:  +44 1865 272595

--
François Pinard   http://pinard.progiciels-bpi.ca

______________________________________________
[hidden email] mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel