Skip to content

Commit 52c3b67

Browse files
authored
add note about generics from base / utils functions, closes #131 (#133)
1 parent 10de37b commit 52c3b67

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

r-code.Rmd

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,13 @@ Bioconductor. One example of a generic and method implementation is that of the
5454
numeric vector of the same length as the rows and is adhered to across classes
5555
including the `DelayedMatrix` class. Re-using generics reduces the amount of
5656
new generics by consolidating existing operations and avoids the mistake of
57-
introducing a "new" generic with the same name. Generic name collisions may
58-
mask or be masked by previous definitions in ways that are hard to diagnose.
59-
More recently, we recommend the use of `r BiocStyle::CRANpkg("conflicted")` to
60-
identify namespace collisions.
57+
introducing a "new" generic with the same name. Note that in order to re-use
58+
a generic, the behavior of the method should align with the originally
59+
proposed behavior of the generic. Avoid creating generics from existing `base`
60+
or `utils` functions as this can lead to confusion and conflicts with
61+
existing functions and generics. Generic name collisions may mask previous
62+
definitions in ways that are hard to debug and diagnose. We recommend the use of
63+
`r BiocStyle::CRANpkg("conflicted")` to identify namespace collisions.
6164

6265
If there are problems, e.g., in performance or parsing your particular
6366
file type, ask for input from other developers on the

0 commit comments

Comments
 (0)