mmeierer / REndo

REndo - A R package to control for endogeneity by using internal instrumental variable models
15 stars 4 forks source link

Rd files need updates for HTML5 #67

Closed Rgui closed 2 years ago

Rgui commented 2 years ago

The current development version of R has recently switched to use HTML5 for documentation pages (PR#18149). Now validation using HTML tidy finds the following problems in your Rd files (problems only shown once per Rd file):

REndo::copulaCorrection.Rd: Warning:

element removed from HTML5 REndo::hetErrorsIV.Rd: Warning:
element removed from HTML5 REndo::higherMomentsIV.Rd: Warning:
element removed from HTML5 REndo::higherMomentsIV.Rd: Warning:
attribute "align" not allowed for HTML5 REndo::latentIV.Rd: Warning:
element removed from HTML5 REndo::multilevelIV.Rd: Warning:
element removed from HTML5 REndo::vcov.rendo.boots.Rd: Warning:
element removed from HTML5 REndo::vcov.rendo.boots.Rd: Warning: unescaped & or unknown entity "̅-"

Can you please fix as necessary?

The problems reported are one of

Warning:

element removed from HTML5 Warning: element removed from HTML5 Warning: element removed from HTML5

Warning:

attribute "align" not allowed for HTML5 Warning:
attribute "align" not allowed for HTML5 Warning:

attribute "align" not allowed for HTML5 Warning:

attribute "align" not allowed for HTML5

See https://html.spec.whatwg.org/#obsolete-but-conforming-features for info on these: in principle, all can be fixed by using style attributes, e.g.

style='text-align: right;'

instead of align='right' etc., which will work for both the new and old ways of converting Rd to HTML.

Please fix before 2022-03-15 to safely retain your package on CRAN.

pschil commented 2 years ago

I have fixed some of the things mentioned here (#68) but not sure where I can verify whether it is fine now. How did you receive these issues? By email? The current CRAN check results seem fine for all versions, incl development. (link)

pschil commented 2 years ago

In separate report also:

REndo::vcov.rendo.boots.Rd: Warning: unescaped & or unknown entity "&#773"

pschil commented 2 years ago

According to this official blog post (Link) and the current R CMD checks code (Link), these tests for tidy html5 do exist (check_Rd2HTML) but are not executed for documentation written with roxygen2. Because all docu for REndo is written with roxygen2, the docu is currently not checked for untidy html5. I have nevertheless fixed these issues to the best of my knowledge, without being able to verify that it is actually fixed.