search

datacamp / rdocumentation-2.0

📚 RDocumentation provides an easy way to search the documentation for every version of every R package on CRAN and Bioconductor.
https://rdocumentation.org
MIT License
285 stars 44 forks source link

Update to write() documentation in base #78

Closed cdputnam closed 2 years ago

cdputnam commented 3 years ago

I apologize if this is not the correct place to suggest a documentation update to R base functions, but it was not clear to me where else I should do so.

The write() function, which is a wrapper to cat(), says the following about the append option:

if TRUE the data x are appended to the connection.

The cat() function has the following to say about append:

logical. Only used if the argument file is the name of file (and not a connection or "|cmd"). If TRUE output will be appended to file; otherwise, it will overwrite the contents of file.

It appears the the append option in write() actually follows the behavior of cat(), at least in response to a connection. Should the append option in write() contain the same comments as in cat()? The description in cat() allowed to figure out my problems when calling write() on a connection with append=TRUE.

Thanks.

ben-brooker commented 2 years ago

Closing this issue because this is an issue related to the package itself. Rdocumentation.org acts as a library to present information about all packages on CRAN, bioc and github in a user-friendly way. Consider reaching out to the author of the package! :)