[R-pkg-devel] Possible bug in Codoc checking with R CMD Check

[biii m@iii@g oii de@@ey@ws]

Hello,

 

I have a function that is used to generate LaTeX code for reporting.  When
doing R CMD check, I get an error that the "\\ldots" argument does not match
between the code and documentation.  I think that the error is coming from
the Codoc check in R CMD check not escaping the backslash before ldots.  Is
my diagnosis correct?  If so, what is the best way to report this as a bug
in R CMD check?

 

The R CMD check warning:

 

Warning: Codoc mismatches from documentation object
'topic_long_table_header':

topic_long_table_header

  Code: function(x, col_names = NULL, above_col_names = "\\hline",

                 below_col_names = "\\hline",

                 subsequent_page_notification = "\\ldots continued",

                 latex_header = NULL, verbatim = NULL)

  Docs: function(x, col_names = NULL, above_col_names = "\\hline",

                 below_col_names = "\\hline",

                 subsequent_page_notification = "\... continued",

                 latex_header = NULL, verbatim = NULL)

  Mismatches in argument default values:

    Name: 'subsequent_page_notification' Code: "\\ldots continued" Docs:
"\... continued"

 

The function looks like:

 

topic_long_table_header <- function(x,

                                    col_names=NULL,

                                    above_col_names="\\hline",
below_col_names="\\hline",

                                    subsequent_page_notification="\\ldots
continued",

                                    latex_header=NULL,

                                    verbatim=NULL) {

 # do stuff here

}

 

The .Rd file (generated by roxygen2) looks like:

 

topic_long_table_header(

  x,

  col_names = NULL,

  above_col_names = "\\\\hline",

  below_col_names = "\\\\hline",

  subsequent_page_notification = "\\\\ldots continued",

  latex_header = NULL,

  verbatim = NULL

)

 

If looking in more detail would help, relevant parts of the GitHub repo are:

 

https://github.com/billdenney/TopicLongTableR/blob/main/R/topic_long_table_h
eader_footer.R

https://github.com/billdenney/TopicLongTableR/blob/main/man/topic_long_table
_header.Rd

https://github.com/billdenney/TopicLongTableR/actions/runs/5771551599/job/15
645624146#step:6:99

 

Thanks,

 

Bill


	[[alternative HTML version deleted]]