Thank your for the solution attempt. However, using the keyword internal does not solve the problem, the note is still there. Any other proposals for properly documenting a function that looks like an S3 method, but isn't?

Best, Ulrike

Am 05.05.2023 um 12:56 schrieb Iris Simmons:
You can add

\keyword{internal}

to the Rd file. Your documentation won't show up the in the pdf manual, it won't show up in the package index, but you'll still be able to access the doc page with ?levels.no <http://levels.no> or help("levels.no <http://levels.no>").

This is usually used in a package's deprecated and defunct doc pages, but you can use it anywhere.

On Fri, May 5, 2023, 06:49 Ulrike Groemping <ulrike.groemp...@bht-berlin.de> wrote:

    Dear package developeRs,

    I am working on fixing some notes regarding package DoE.base.
    One note refers to the function levels.no <http://levels.no> and
    complains that the
    function is not documented as a method for the generic function
    levels.
    Actually, it is not a method for the generic levels, but a standalone
    internal function that I like to have documented.

    Is there a way to document the function without renaming it and
    without
    triggering a note about method documentation?

    Best, Ulrike

-- ##############################################
    ## Prof. Ulrike Groemping
    ## FB II
    ## Berliner Hochschule für Technik (BHT)
    ##############################################
    ## prof.bht-berlin.de/groemping <http://prof.bht-berlin.de/groemping>
    ## Phone: +49(0)30 4504 5127
    ## Fax:   +49(0)30 4504 66 5127
    ## Home office: +49(0)30 394 04 863
    ##############################################

    ______________________________________________
    R-package-devel@r-project.org mailing list
    https://stat.ethz.ch/mailman/listinfo/r-package-devel


______________________________________________
R-package-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-package-devel

Reply via email to