Skip to content

Commit d501383

Browse files
committed
Document return value for R6 objects
1 parent 9025088 commit d501383

8 files changed

Lines changed: 52 additions & 32 deletions

R/AbstractAnnData.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
#'
3232
#' See [AnnData-usage] for details on creating and using `AnnData` objects.
3333
#'
34+
#' @return An `AbstractAnnData` object
35+
#'
3436
#' @seealso [AnnData-usage] for details on creating and using `AnnData` objects
3537
#'
3638
#' @family AnnData classes

R/AnnData-usage.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@
7070
#'
7171
#' @section Methods:
7272
#'
73+
#' @return An `AnnData` object inheriting from [`AbstractAnnData`]
74+
#'
7375
#' ## Conversion methods:
7476
#'
7577
#' \describe{

R/HDF5AnnData.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
#'
66
#' See [AnnData-usage] for details on creating and using `AnnData` objects.
77
#'
8+
#' @return An `HDF5AnnData` object
9+
#'
810
#' @seealso [AnnData-usage] for details on creating and using `AnnData` objects
911
#'
1012
#' @family AnnData classes

R/InMemoryAnnData.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
#'
66
#' See [AnnData-usage] for details on creating and using `AnnData` objects.
77
#'
8+
#' @return An `InMemoryAnnData` object
9+
#'
810
#' @seealso [AnnData-usage] for details on creating and using `AnnData` objects
911
#'
1012
#' @family AnnData classes

man/AbstractAnnData.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/AnnData-usage.Rd

Lines changed: 35 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/HDF5AnnData.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/InMemoryAnnData.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)