more edits

Author: IndrajeetPatil

R/ui-caching.R

@@ -8,7 +8,7 @@
 #'   `NULL`, the option "styler.cache_name" is considered which defaults to
 #'   the version of styler used.
 #' @details
-#' Each version of styler has it's own cache by default, because styling is
+#' Each version of styler has its own cache by default, because styling is
 #' potentially different with different versions of styler.
 #' @param ask Whether or not to interactively ask the user again.
 #' @family cache managers
@@ -61,7 +61,7 @@ NULL
 #'
 #' Gives information about the cache. Note that the size consumed by the cache
 #' will always be displayed as zero because all the cache does is creating an
-#' empty file of size 0 bytes for every cached expression. The innode is
+#' empty file of size 0 bytes for every cached expression. The inode is
 #' excluded from this displayed size but negligible.
 #' @param cache_name The name of the cache for which to show details. If
 #'   `NULL`, the active cache is used. If none is active the cache corresponding

R/ui-styling.R

@@ -1,4 +1,4 @@
-#' @api
+#' @keywords api
 #' @import tibble
 #' @importFrom magrittr %>%
 NULL

man/cache_clear.Rd

@@ -18,11 +18,11 @@ knitr::opts_chunk$set(
 library(styler)
 ```
 
-This is a developer vignette to explain how caching works and what we learned on the way. To use the caching feature, please have a look at the README.
+This is a developer vignette to explain how caching works and what we learned on the way.
 
 The main caching features were implemented in the following two pull requests:
 
--   #538: Implemented simple caching and utilities for managing caches. Input text is styled as a whole and added to the cache afterwards. This makes most sense given that the very same expression will probably never be passed to styler, unless it is already compliant with the style guide. Apart from the (negligible) innode, caching text has a memory cost of 0. Speed boosts only result if the whole text passed to styler is compliant to the style guide in use. Changing one line in a file with hundreds of lines means each line will be styled again. This is a major drawback and makes the cache only useful for a use with a pre-commit framework (the initial motivation) or when functions like `style_pkg()` are run often and most files were not changed.
+-   #538: Implemented simple caching and utilities for managing caches. Input text is styled as a whole and added to the cache afterwards. This makes most sense given that the very same expression will probably never be passed to styler, unless it is already compliant with the style guide. Apart from the (negligible) inode, caching text has a memory cost of 0. Speed boosts only result if the whole text passed to styler is compliant to the style guide in use. Changing one line in a file with hundreds of lines means each line will be styled again. This is a major drawback and makes the cache only useful for a use with a pre-commit framework (the initial motivation) or when functions like `style_pkg()` are run often and most files were not changed.
 
 -   #578: Adds a second layer of caching by caching top-level expressions individually. This will bring speed boosts to the situation where very little is changed but there are many top-level expressions. Hence, changing one line in a big file will invalidate the cache for the expression the line is part of, i.e. when changing `x <- 2` to `x = 2` below, styler will have to restyle the function definition, but not `another(call)` and all other expressions that were not changed.