Reduce R6 boilerplate and add $ prefix to methods title#1814
Conversation
Fixes #1258
hadley
changed the title
$ prefix to methods title
gaborcsardi
left a comment
gaborcsardi
left a comment
There was a problem hiding this comment.
My main worry with these kind of things in general is that it generates a lot of small differences in the output, that people will need (?) to look at, and I am not entirely sure if the output being a bit better justifies the extra work.
But again, this is not a very strong opinion...
| usage <- format(function_usage(fake, x$formals)) | ||
| push_subsection( | ||
| "Usage", | ||
| push( |
There was a problem hiding this comment.
I like these sections because R users are familiar with them already, and they introduce more structure. The same with the 'Method' prefix. I think it is ok to make the docs more verbose if it helps discovery and reduces ambiguity. I agree that the boilerplate can be very repetitive, but I think for a reference manual that is ok. (Not for a tutorial otoh.)
But this is somewhat subjective, and I don't have a very strong opinion about these changes, so feel free to go ahead with them.
|
@gaborcsardi FWIW there are going to be a bunch of minor changes in this release, so I think it'll be ok. |
|
Yeah, looking at this again, it feels a bit too minimal to me. Lets keep brainstorming in #1815. |
2 participants
Fixes #1153. Fixes #1258.
@gaborcsardi I filed the original issue. What do you think?