tidy-deprecate-function
Przewodnik do wycofywania funkcji i parametrów w pakietach R z pełną dokumentacją
Instalacja
Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.
Instalacja
O skillu
Skill wspierający proces deprecacji funkcji i parametrów w pakietach R. Automatyzuje dodawanie ostrzeżeń lifecycle, aktualizację dokumentacji, wpisy w NEWS.md oraz testy. Zapewnia spójność zmian na wszystkich poziomach: kod, testy, dokumentacja i historia zmian. Idealny dla opiekunów pakietów R, którzy muszą wycofywać stare interfejsy bez przerywania pracy użytkowników.
Jak używać
Zainstaluj skill w swoim środowisku Claude, wskazując repozytorium r-lib/devtools. Skill będzie dostępny, gdy poprosisz o deprecację funkcji lub parametru w pakiecie R.
Przygotuj informacje o wycofywanym elemencie: nazwę funkcji lub parametru, którą chcesz deprecjonować, oraz ewentualną funkcję zastępczą. Sprawdź aktualną wersję w pliku DESCRIPTION.
Skill obliczy wersję deprecacji (następny minor release) na podstawie obecnej wersji. Na przykład jeśli obecna wersja to 2.5.1.9000, wersja deprecacji będzie 2.6.0.
Dodaj wywołanie lifecycle::deprecate_warn() do funkcji lub parametru. Dla funkcji użyj lifecycle::deprecate_warn("X.Y.0", "function_name()", "replacement_function()"), dla parametru sprawdź jego obecność za pomocą lifecycle::is_present().
Zaktualizuj istniejące testy, aby wyciszyć ostrzeżenia deprecacji, dodaj nowy test sprawdzający, czy ostrzeżenie jest wyświetlane, oraz dodaj wpis do NEWS.md opisujący zmianę.
Dodaj badge lifecycle do dokumentacji funkcji, aby użytkownicy byli świadomi deprecacji podczas czytania pomocy.