Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-19568

Must include class/method documentation for CRAN check

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Incomplete
    • 2.1.0
    • None
    • SparkR

    Description

      While tests are running, R CMD check --as-cran is still complaining

      * checking for missing documentation entries ... WARNING
      Undocumented code objects:
        ‘add_months’ ‘agg’ ‘approxCountDistinct’ ‘approxQuantile’ ‘arrange’
        ‘array_contains’ ‘as.DataFrame’ ‘as.data.frame’ ‘asc’ ‘ascii’ ‘avg’
        ‘base64’ ‘between’ ‘bin’ ‘bitwiseNOT’ ‘bround’ ‘cache’ ‘cacheTable’
        ‘cancelJobGroup’ ‘cast’ ‘cbrt’ ‘ceil’ ‘clearCache’ ‘clearJobGroup’
        ‘collect’ ‘colnames’ ‘colnames<-’ ‘coltypes’ ‘coltypes<-’ ‘column’
        ‘columns’ ‘concat’ ‘concat_ws’ ‘contains’ ‘conv’ ‘corr’ ‘count’
        ‘countDistinct’ ‘cov’ ‘covar_pop’ ‘covar_samp’ ‘crc32’
        ‘createDataFrame’ ‘createExternalTable’ ‘createOrReplaceTempView’
        ‘crossJoin’ ‘crosstab’ ‘cume_dist’ ‘dapply’ ‘dapplyCollect’
        ‘date_add’ ‘date_format’ ‘date_sub’ ‘datediff’ ‘dayofmonth’
        ‘dayofyear’ ‘decode’ ‘dense_rank’ ‘desc’ ‘describe’ ‘distinct’ ‘drop’
      ...
      

      This is because of lack of .Rd files in a clean environment when running against the content of the R source package.
      I think we need to generate the .Rd files under man\ when building the release and then package with them.

      Attachments

        Activity

          People

            felixcheung Felix Cheung
            felixcheung Felix Cheung
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: