paul-buerkner/brms

Use roxygen templates in the documentation

Open

#780 opened on Oct 29, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)R (220 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (1,402 stars)
PR merge metrics
 (Avg merge 7d 21h) (1 merged PR in 30d)

Description

This should reduce the number of duplicated documentation snippets and replace @inheritParams tags.

Contributor guide

Research direction
Examine the current documentation files to identify duplicated snippets and replace them with roxygen templates, ensuring that @inheritParams is used appropriately.
Tech stack
r
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rroxygen2
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75