search

Bioconductor / HDF5Array

HDF5 backend for DelayedArray objects
https://bioconductor.org/packages/HDF5Array
9 stars 13 forks source link

export utility functions and add documentation page #39

Closed LiNk-NY closed 3 years ago

LiNk-NY commented 3 years ago

Hi Hervé, @hpages I was not sure to what extent you wanted the functions to be documented (given that these functions are for developers and can change at any time). I've only provided descriptions and updated the NAMESPACE file. Thanks! -Marcel

hpages commented 3 years ago

No need to document them for now. The Rd file should be named HDF5Array-internals.Rd and contain the following \name, \title and \description:

\name{HDF5Array-internals}

\alias{...}
\alias{...}
...

\title{HDF5Array internals}

\description{
  Internal utilities defined in the \pkg{HDF5Array} package. These functions that are not
  intended to be used directly.
}

\keyword{internal}

Also the dot prefix for those internal utilities that get exported would need to be dropped.

Thanks Marcel.

LiNk-NY commented 3 years ago

Hi Hervé, @hpages Thanks for the quick response. I've made the changes. I can take care of the rest, version bump and push to upstream if you give the go ahead. :+1: You can also do this by clicking Approve in the review options. -Marcel

hpages commented 3 years ago

Sure please go ahead. Thanks!