rstudio/plumber

Looking for annotation reference

Open

#321 geöffnet am 16. Okt. 2018

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)R (257 Forks)batch import
difficulty: novicedocseffort: lowhelp wanted

Repository-Metriken

Stars
 (1.437 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Is there a listing anywhere of all the annotations that Plumber supports? The section on rplumber.io is blank at the moment.

Contributor Guide

Research-Richtung
Das Issue fordert eine umfassende Liste aller von Plumber unterstützten Annotationen an, da die Dokumentationsseite derzeit leer ist. Ein Mitwirkender sollte den Plumber Quellcode, insbesondere das R/ Verzeichnis für Funktionsdefinitionen mit anmerkungsbezogenen Kommentaren, untersuchen oder bestehende Tests auf Annotationsbeispiele prüfen. Zudem könnte die Überprüfung verknüpfter PRs oder Dokumentationsentwürfe im Repository Hinweise liefern. Das Endergebnis sollte entweder eine neue Dokumentationsseite oder eine Aktualisierung der bestehenden leeren Seite sein.
Tech Stack
Keine
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.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Basic R knowledgeFamiliarity with Plumber API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45