Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated HTML snippet in roxygen generated Rd files #221

Closed
luukvdmeer opened this issue Aug 11, 2022 · 3 comments
Closed

Outdated HTML snippet in roxygen generated Rd files #221

luukvdmeer opened this issue Aug 11, 2022 · 3 comments
Labels
bug 🐛 Something isn't working documentation 📝 Related to documentation tasks

Comments

@luukvdmeer
Copy link
Owner

E-mail from CRAN:

Dear maintainer,

Please see the problems shown on
https://cran.r-project.org/web/checks/check_results_sfnetworks.html.

In particular, please see the "Found the following HTML validation
problems" NOTEs in the "HTML version of manual" check for the r-devel
debian checks results.

R 4.2.0 switched to use HTML5 for documentation pages. Now validation
using HTML Tidy finds problems in the HTML generated from your Rd files
of the form

element removed from HTML5

element removed from HTML5 attribute "align" not allowed for HTML5 attribute "hspace" not allowed for HTML5 attribute "width" has invalid value "120px" attribute "width" has invalid value "480px" attribute "width" has invalid value "50px" attribute "width" has invalid value "72px"

For the first four, please 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.

For the second four, simply drop the px units: the HTML5 standard asks
for a non-negative integer implied to be in CSS pixels.

Can you please fix as necessary?

Note that the problems are found in Rd files auto-generated with
roxygen2: to fix it might suffice to re-generate these using the current
CRAN version of roxygen2.

Please correct before 2022-09-01 to safely retain your package on CRAN.

Best,
-k

@luukvdmeer luukvdmeer added bug 🐛 Something isn't working documentation 📝 Related to documentation tasks labels Aug 11, 2022
@luukvdmeer
Copy link
Owner Author

It is actually not about vignettes, but about .Rd files generated by roxygen2. Especially the sfnetworks-package.Rd file, which shows our logo and uses 'align=right' in the HTML snippet. That is not supported anymore in HTML5, apparently. Should be an easy fix by updating roxygen2 and re-generate the Rd file.

@luukvdmeer luukvdmeer changed the title HTML rendering of vignettes results in new CRAN errors Outdated HTML snippet in roxygen generated Rd files Aug 18, 2022
@Robinlovelace
Copy link
Collaborator

At a glance this looks relevant, hope of use, if not of interest: https://github.com/DavisVaughan/extrachecks-html5

@luukvdmeer
Copy link
Owner Author

Thanks @Robinlovelace, for now updating roxygen2 worked for us, but if new issues occur we should probably run those checks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something isn't working documentation 📝 Related to documentation tasks
Projects
None yet
Development

No branches or pull requests

2 participants