Skip to content

[R-pkg-devel] Undocumented code objects: '.__global__'

3 messages · Ivan Krylov, Johannes Ranke

Original
Johannes Ranke
# 
Dear all,

while preparing a maintenance release of a dated package of mine, I was struck 
by this WARNING from the R-devel version of win-builder:

* checking for missing documentation entries ... WARNING
Undocumented code objects:
  '.__global__'

I don't understand where this code object '__global__' may come from. I 
checked in the R/*.R sources as well as in the data/*.rda files.

The package source lives here:

https://cgit.jrwb.de/drfit

Kind regards,

Johannes
Ivan Krylov
# 
On Fri, 21 Jul 2023 09:43:49 +0200
Johannes Ranke <johannes.ranke at jrwb.de> wrote:

            

      
      
      
    

        
It's an implementation detail of utils::globalVariables(). Normally, R
CMD check wouldn't complain about it, but because of exportPattern(".")
in your NAMESPACE it's exported, and thus considered to be a part of
your package's API, and thus required to be documented.

It may involve more typing, but export()ing individual functions will
prevent your package from exporting some other non-API object by
accident.

  
    

      
      
    

  


  


      

    

    

      
      

        


  

        

      Johannes Ranke
    

    

      
      #
    

  


  

      
Am Freitag, 21. Juli 2023, 09:47:52 CEST schrieb Ivan Krylov:

            

      
      
      
    

        
Thanks, Ivan, for your insightful coment!

Specifying exports in the NAMESPACE file solved it.

Kind regards,

Johannes