scales icon indicating copy to clipboard operation
scales copied to clipboard

update label_percent ... documentation

Open pearsonca opened this issue 3 years ago • 3 comments
trafficstars

addresses #356: reflects pass through label_number first (i.e. can also include style_+/-)

also update internals of label_percent to skip superceded function.

pearsonca avatar Aug 25 '22 20:08 pearsonca

I'm not a maintainer of this package, but it seems like this is one of those use cases where @inheritDotParams would shine. For more information, see this paragraph of the R packages book.

teunbrand avatar Aug 30 '22 10:08 teunbrand

Hmm, agree. Wait one.

On Tue, Aug 30, 2022 at 11:52 AM Teun van den Brand < @.***> wrote:

I'm not a maintainer of this package, but it seems like this is one of those use cases where @inheritDotParams would shine. For more information, see this paragraph https://r-pkgs.org/man.html#inheriting-documentation of the R packages book.

— Reply to this email directly, view it on GitHub https://github.com/r-lib/scales/pull/361#issuecomment-1231498224, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAN6JR7Y4BUEAM7S4FRIPP3V3XRWLANCNFSM57UMJFTQ . You are receiving this because you authored the thread.Message ID: @.***>

pearsonca avatar Aug 30 '22 10:08 pearsonca

Okay, so yes, but: https://github.com/r-lib/roxygen2/issues/633 - inheriting dots does not properly document that even more arguments may be passed on from wrapped function.

To address this issue, I think @inheritDotParams is preferrable (fewer clicks for end user, simple implementation for dev), however it is not complete documentation without a fix to that roxygen issue (which is currently closed).

edit: and bizarrely, now @inheritParams label_percent for percent_format does not seem to properly detect the ... params definition. that also doesn't seem like a problem, since it's superceded, but no idea what's going on there.

pearsonca avatar Aug 30 '22 11:08 pearsonca

Fixed outside of this issue. However, thanks for looking into it! ❤️

thomasp85 avatar Nov 01 '23 10:11 thomasp85