fix-members-short-description

Skill do Claude/Copilot, który formatuje opisy członków klas i typów Python zgodnie ze standardami dokumentacji Flet. Narzędzie analizuje docstringi w plikach Python i zapewnia, że pierwsze zdanie każdego opisu jest poprawnie złamane na wiele linii ze znakami \, gdy przekracza limit 88 znaków. Automatycznie dodaje # noqa: E501 dla linii zawierających nierozdzielalne tokeny, takie jak długie adresy URL. Idealny dla zespołów utrzymujących dokumentację generowaną z kodu źródłowego.

1. Przygotuj plik lub katalog zawierający moduły Python, których docstringi chcesz naprawić. Upewnij się, że masz dostęp do kodu źródłowego z definicjami klas, enumeracji i ich członków (właściwości, metody).

2. Przekaż ścieżkę do pliku lub katalogu do skilla, wskazując, że chcesz naprawić opisy członków typów Python. Skill przeanalizuje wszystkie docstringi w przekazanych plikach.

3. Skill przejrzy każdy docstring i sprawdzi, czy pierwsze zdanie (krótki opis) jest poprawnie sformatowane. Jeśli zdanie rozciąga się na wiele linii, skill doda znaki \ na końcu każdej linii poza ostatnią, aby je połączyć.

4. Skill upewni się, że każda linia docstringu nie przekracza 88 znaków. Jeśli linia zawiera nierozdzielalne elementy (np. długi URL lub ścieżkę rejestru Windows), skill doda komentarz # noqa: E501 do linii zamykającej """ zamiast łamać tę linię.

5. Skill zastosuje poprawki niezależnie od tego, czy pierwsze zdanie zaczyna się w tej samej linii co otwarcie """, czy na następnej linii.

6. Przejrzyj wygenerowane poprawki i zatwierdź zmiany w swoim repozytorium. Dokumentacja generowana z docstringów będzie teraz wyświetlać prawidłowo sformatowane krótkie opisy.