Skip to content

Commit

Permalink
minor formatting and spell check updates (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
LiNk-NY authored Jan 23, 2024
1 parent 30bda0b commit 3d04e68
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions deprecation.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,16 @@ necessary.

After the promise object has been saved, we update the documentation to
reflect the changes and provide additional details and resources for
users as necessary. It is recommended to include a "[Deprecated]" label in the
data documentation title.
users as necessary. It is recommended to include a "[Deprecated]" label
in the data documentation title.

### Step 3 - Defunct the dataset

In the following release cycle, you can update the warning message to indicate
that the dataset is defunct and remove it entirely from the promise object
i.e., from the expression in the `delayedAssign` function. We can also update
the "[Deprecated]" label in the documentation title to "[Defunct]".
the "[Deprecated]" label in the documentation title to
"[Defunct]".

## How to Deprecate a Package {#deprecate-package}

Expand Down
4 changes: 2 additions & 2 deletions r-code.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -265,10 +265,10 @@ highly encouraged.

## R Code Best Practices and Guidelines

Many common coding and sytax issues are flagged in `R CMD check` and
Many common coding and syntax issues are flagged in `R CMD check` and
`BiocCheck()` (see the `R CMD check`
[cheatsheet](http://r-pkgs.had.co.nz/check.html) and `r BiocStyle::Biocpkg("BiocCheck", vignette = "BiocCheck.html")` vignette. Every
effort should be made to clear up ERROR, WARNING, or Notes produced from these
effort should be made to clear up ERROR, WARNING, or NOTEs produced from these
checks.

### Code syntax and efficiency
Expand Down

0 comments on commit 3d04e68

Please sign in to comment.