tidyverts / tidyverts/fabletools

Think about adding roxygen topics for "special" functions

Open
#425 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
98
Forks
37
PR merge metrics
No merged PRs in 30d

Description

I got a question in the workshop about the fact that you can't do ?drift and pull up any information on the drift() special. I get that this isn't a "real" function, but I wonder if you could somehow add a topic page so that ?drift takes you to the ?NAIVE page so you can still see something like this https://fable.tidyverts.org/reference/RW.html#specials

If drift() can be used in multiple different model types, maybe it can be a landing page specific to drift that can let you then click through to whatever specific model you are interested in using drift with

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the existing roxygen documentation behind the ?NAIVE page and the special-function references linked from the issue, then check how ?drift currently resolves. Decide whether drift needs a standalone landing topic or links into model-specific topics; done means ?drift opens useful documentation for the special and the relevant model paths remain discoverable.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.