jeanimal / heuristica

Heuristic functions in R, such as Take The Best, unit-weighted linear (Dawes' rule), plus helper functions.
Other
5 stars 2 forks source link

Required for CRAN warnings_are_errors: true #28

Closed jeanimal closed 8 years ago

jeanimal commented 8 years ago

If you set this to true AND check in code that causes documentation to be rebuilt, you will see a bunch of warnings that now break the build. These warnings should be fixed so we can set warnings_are_errors: true, which is required for CRAN.

Here is an example of build output when warnings_are_errors: true. The gist is we have too many lines in our documentation that are too wide for the pdf. I just don't have time to fix them while I'm in the middle of other work now.

https://travis-ci.org/jeanimal/heuristica/builds/109016838

Click on the triangle to the left of "R CMD check logs" to see the detailed log. Scroll all the way down to stuff like this:

Overfull \hbox (20.58041pt too wide) in paragraph at lines 88--88 []\T1/pcr/m/n/9 ## Generate a matrix with the correct values and the heuristics\TS1/pcr/m/n/9 ' \T1/pcr/m/n/9 predictions:[]

Overfull \hbox (15.18042pt too wide) in paragraph at lines 89--89 []\T1/pcr/m/n/9 out2 <- allRowPairApply(city_population, criterion(3), heuristics(reg, ttb))[]

There is a lot. This is super-annoying because I don't know a way to reproduce this error locally. devtools::check() says everything is okay. So step 1 would be to find a way to get this warning without having to submit to travis.
jeanimal commented 8 years ago

Confirmed fixed in commit e4127e60947678a9ced3b762d3cad59f0352876e by manually editing all lines to be < 80 chars.

I made use of this little bash trick to identify lines > 80 chars: grep '.{80}' filename but I still had to manually edit the offenders to wrap to the next line.

Then I again set warnings_are_errors: true and confirmed the travis build worked. (I did not find a way to reproduce the warning locally.)