Regenerate documents using roxygen2 7.0 #3630
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yutannihilation
commented
Nov 17, 2019
Comment on lines
-142
to
+217
| and x axis grid lines are vertical. \code{panel.grid.*.*} inherits from | ||
| \code{panel.grid.*} which inherits from \code{panel.grid}, which in turn inherits | ||
| and x axis grid lines are vertical. \verb{panel.grid.*.*} inherits from | ||
| \verb{panel.grid.*} which inherits from \code{panel.grid}, which in turn inherits |
There was a problem hiding this comment.
I'm not sure if this is a problem or not, but I reported here: r-lib/roxygen2#975
yutannihilation
commented
Nov 17, 2019
| @@ -51,5 +61,5 @@ p + annotate("text", x = 2:3, y = 20:21, label = c("my label", "label 2")) | |||
| p + annotate("text", x = 4, y = 25, label = "italic(R) ^ 2 == 0.75", | |||
| parse = TRUE) | |||
| p + annotate("text", x = 4, y = 25, | |||
| label = "paste(italic(R) ^ 2, \\" = .75\\")", parse = TRUE) | |||
| label = "paste(italic(R) ^ 2, \" = .75\")", parse = TRUE) | |||
There was a problem hiding this comment.
Hmm, is this correct...?
There was a problem hiding this comment.
It seems this escape doesn't make difference on the rendered document.
|
OK, this is not a easy job by just running Warnings when
|
yutannihilation
changed the title
yutannihilation
changed the title
|
This is ready to merge now, if we are ready to use roxygen2 (apparently I was not...) |
|
Closing this in favor of #3637 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use the latest version of roxygen2 to generate documents, and fix various places due to the change of roxygen2's behaviour.
Formatting of Usage sections
Most of the diff comes from the fact that roxygen2 now formats usages a bit prettier than before. For example:
This diff is harmless and there's nothing we need to do.
Escape of
%Contrary to the previous version where we needed to escape
%by ourselves, now roxygen2 escapes%automatically. As a result,#' 100\%is converted to
100\\%Here,
\\is translated as an escaped\and%is translated as an unescaped%, which means the Rd comment symbol. This is problematic when it's used in a line containing}. For example,is translated as
\item{width}{Bar width. By default, set to 90\\+ comments.So, we must remove this
\except when it's used in raw Rd macros (e.g.\code{}). For example,#' \code{\%+\%}should be left as is.
Unused
@inheritParamsIt seems roxygen2 now warns when
@inheritParamsis not used. I removed two@inheritParams. This doesn't change the result documents as they ware not used actually.Misuse of
@rdnameI think we misuse
@rdnamein some places where we should use@name. I don't understand whydevtools::document()warns only forscale-step, but I guess this is what the following warning suggests: