paul-buerkner/brms

Use roxygen templates in the documentation

Open

#780 geöffnet am 29. Okt. 2019

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)R (220 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (1.402 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 7T 21h) (1 gemergte PR in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche die aktuellen Dokumentationsdateien, um doppelte Codeausschnitte zu identifizieren und durch Roxygen Vorlagen zu ersetzen. Stelle sicher, dass @inheritParams angemessen verwendet wird.
Tech Stack
r
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rroxygen2
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75