styler icon indicating copy to clipboard operation
styler copied to clipboard

Published 20 hours ago • verified publisher icon r-lib

Document the styling UI in a single `.Rd` file?

Open IndrajeetPatil opened this issue 3 years ago • 1 comments
trafficstars

Currently, these functions are separately documented and there is a lot of duplication of the content.

Screenshot 2022-07-29 at 14 54 04

Instead, we could do this the same way {lintr} does it; cataloguing them in a single place.

Screenshot 2022-07-29 at 14 54 32

If you agree, I can make a PR.

IndrajeetPatil avatar Jul 29 '22 12:07 IndrajeetPatil

I do see there is a lot of duplication. Mostly kn the user side though. At source, there is very little due to inheritance and smart use of roxygen. I think addin and text are distinct from the file formatters so my suggestion is to merge file, dir, and package and then see what to do with text. Some sections from some of the help files are also applicable to other docs, so maybe we could also make sure that’s consistent. I’d appreciate a PR.

lorenzwalthert avatar Jul 29 '22 20:07 lorenzwalthert

Not planned. See https://github.com/r-lib/styler/pull/972#issuecomment-1214142705.

IndrajeetPatil avatar Aug 15 '22 06:08 IndrajeetPatil