Skip to content

Commit 80b2d01

Browse files
committed
Mention overrides and defaults in doc too
1 parent 6cdec1d commit 80b2d01

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

doc/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ Ark overrides a number of R options during startup, *after* sourcing the user's
5454

5555
## `positron.protected_options`
5656

57-
A character vector of option names that Positron should leave alone. Set this in your `.Rprofile` to prevent Positron from overriding specific options. Accepted values are the option names listed under *Set unless protected* below. It can also be used for any of the options listed under *Set if not `NULL`* and *Package options* to preserve their `NULL` default. For example:
57+
A character vector of option names that Positron should leave alone. Set this in your `.Rprofile` to prevent Positron from overriding specific options. Accepted values are the option names listed under *Overrides* below. It can also be used for any of the options listed under *Defaults* to preserve their `NULL` default. For example:
5858

5959
```r
6060
options(
6161
positron.protected_options = c("browser", "editor", "max.print")
6262
)
6363
```
6464

65-
## Set unless protected
65+
## Overrides
6666

6767
These base R options have non-`NULL` defaults, so we can't detect user overrides by checking for `NULL`. They are always set unless listed in `positron.protected_options`.
6868

@@ -73,7 +73,7 @@ These base R options have non-`NULL` defaults, so we can't detect user overrides
7373
- **`device`** — Set to `".ark.graphics.device"`, the function name that `dev.new()` and `GECurrentDevice()` look for when creating a new graphics device.
7474
- **`max.print`** — Set to `1000` (R's own default is `99999`). Limits console output to avoid overwhelming the display.
7575

76-
## Set if not `NULL`
76+
## Defaults
7777

7878
These options are only set when the user has *not* already defined them (e.g. in `.Rprofile`). This allows users to simply set the option to any value to override Positron's default. They can also be listed in `positron.protected_options` to keep the option as `NULL`.
7979

0 commit comments

Comments
 (0)