Skip to content

Improve user facing documentation #8

Open
Open
Improve user facing documentation#8
Labels
documentation

Description

@hadley
hadley
opened on Aug 24, 2018

So that (e.g.) ?fit provides something useful

Currently the documentation is aimed at the developer, but most of the time the person reading them will be a user looking for documentation about that function. I think that means that the modelling functions need to be broken down into smaller pieces (documenting tightly related functions), and the current documentation moved to (e.g.) @section For package authors:.

Activity

  1. batpigandme
    added
    docs
    on Nov 6, 2018

  2. charliejhadley commented on Nov 25, 2019

    @charliejhadley
    charliejhadley
    on Nov 25, 2019

    Good docs take a lot of effort, in the meantime would you be open to a PR to add examples to the major user facing functions like fit and interpolate?

    e.g. this example https://tidyverts.github.io/tidy-forecasting-principles/methods.html#interpolation on the interpolate() page

    library("tsibbledata")
library("fable")
olympic_running %>% 
  model(arima = ARIMA(Time ~ trend())) %>% 
  interpolate(olympic_running)
  3. DavisVaughan
    added
    documentation
    and removed
    docs
    on Jul 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions