Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How should we document methods that have different arguments than the default method? #793

Open
nikosbosse opened this issue Apr 19, 2024 · 0 comments

Comments

@nikosbosse
Copy link
Contributor

In #790 @seabbs introduced the functions as_point() and as_quantile() which transform a forecast object into an object of class forecast_point() and forecast_quantile(), respectively.

For other methods (e.g. score() or is_forecast()) we always lumped all methods into one doc by using @rdname generic_function. This was fine, as all methods had the same arguments.

In this case, the methods have different arguments, depending on the class of the input.

Should all methods appear in one manual page, or should they appear in different ones?

I.e. should we have something like this
image

Or something like this
image

and a separate
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant