search

r-hyperspec / hyperSpec

hyperSpec: Tools for Spectroscopy (R package)
https://r-hyperspec.github.io/hyperSpec/
GNU General Public License v3.0
12 stars 3 forks source link

Rename `new_hyperSpec()` → `hyperSpec()` #129

Closed GegznaV closed 4 months ago

GegznaV commented 5 months ago

To me, working with new_hyperSpec() feels a bit unnatural, so it'd be better to have a constructor function named hyperSpec().

bryanhanson commented 5 months ago

If you do that, and you have a hyperSpec-package.R file, then ?hyperSpec would lead to two help files. R will give the user the options, of course. Just introduces an extra step, but maybe that’s fine. Certainly up to you.Sent from an undisclosed location - check with the NSA.On May 2, 2024, at 9:18 AM, Vilmantas Gegzna @.***> wrote: To me, working with new_hyperSpec() feels a bit unnatural, so it'd be better to have a constructor function named hyperSpec().

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: @.***>

GegznaV commented 5 months ago

Good catch. I had to create aliases as the same name cannot refer to 2 different Rd files. Now ?hyperSpec will refer to the function and package?hyperSpec to the package. I'll update the NEWS file too.

image