Skip to content
Merged
Changes from 1 commit
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
ba98402
Refine classes for blocks
gaborcsardi Sep 26, 2019
f112f86
Extract information from R6 objects
gaborcsardi Sep 26, 2019
70778a0
Make block_to_rd S3 generic
gaborcsardi Sep 26, 2019
852f2ad
Add block formatter for R6 classes
gaborcsardi Sep 26, 2019
b29181f
Use \describe for arguments and @return
gaborcsardi Sep 26, 2019
5ee5a8c
Put R6 method arguments in a table
gaborcsardi Sep 26, 2019
dd7e35b
Warn for undocumented R6 methods
gaborcsardi Sep 26, 2019
3f32db7
Warn for undocumented and duplicate R6 method parameters
gaborcsardi Sep 26, 2019
f2707b7
Put rule before the R6 method, instead after
gaborcsardi Sep 27, 2019
cc25fb2
Add R6 superclass information
gaborcsardi Sep 27, 2019
3fe5173
Omit \describe for R6 return values, breaks Rd2pdf
gaborcsardi Sep 27, 2019
9a8a94e
Leave out @param from an R6 block, but inherit them into methods
gaborcsardi Sep 30, 2019
7554e81
Support R6 fields via @field
gaborcsardi Oct 1, 2019
a7dd5e5
Support R6 active bindings
gaborcsardi Oct 1, 2019
fd1feed
R6 usage and details improvements
gaborcsardi Oct 1, 2019
d1d81d4
Support @description tags for R6 methods
gaborcsardi Oct 1, 2019
f42fecf
Create big \examples section at end of R6 class page
gaborcsardi Oct 1, 2019
7ba770f
Omit R6 \examples block if empty
gaborcsardi Oct 1, 2019
ac235fd
Add NEWS for R6
gaborcsardi Oct 1, 2019
683457c
Include docs about R6 in the Rd vignette
gaborcsardi Oct 1, 2019
5506727
Add internal docs to the RoxyTopic R6 class
gaborcsardi Oct 1, 2019
ad63dda
Change \tabular -> \describe for R6 arg lists
gaborcsardi Oct 2, 2019
64714f2
Refine R6 data extraction
gaborcsardi Oct 2, 2019
8ed5093
Qualify srcref calls from utils::
gaborcsardi Oct 2, 2019
c0baedb
Uniform warnings
gaborcsardi Oct 2, 2019
418d65f
R6 superclass improvements
gaborcsardi Oct 2, 2019
5527356
Improve superclass information
gaborcsardi Oct 3, 2019
c8feb7f
Add more R6 test cases
gaborcsardi Oct 3, 2019
efff7ea
R6 tests for some edge cases
gaborcsardi Oct 3, 2019
b52ac49
Remove R6 tag if cannot be matched to anything
gaborcsardi Oct 3, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Put R6 method arguments in a table
This is what R does with the `\arguments()` blocks.
Not sure how this looks in the PDF, though.
  • Loading branch information
gaborcsardi committed Oct 3, 2019
commit 5ee5a8cda3f79eda65fcd56e5f3d9183c35f9ecd
6 changes: 4 additions & 2 deletions R/rd-r6.R
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,11 @@ r6_method_params <- function(block, method) {
val <- map_chr(par, c("val", "description"))
c(
"\\subsection{Arguments}{",
"\\describe{",
paste0("\\item{", nms, "}{", val, "}", collapse = "\n\n"),
"\\if{html}{\\out{<div class=\"arguments\">}}",
"\\tabular{rl}{",
paste0(nms, "\\tab ", val, "\\cr ", collapse = "\n\n"),
"}",
"\\if{html}{\\out{</div>}}",
"}"
)
}
Expand Down