docstring

Umiejętność pisania docstringów dla funkcji i metod PyTorch w formacie Sphinx/reStructuredText. Automatycznie formatuje dokumentację zgodnie z konwencjami projektu, uwzględniając sygnatury funkcji, opisy, formuły matematyczne i odnośniki do powiązanych komponentów. Idealna dla deweloperów pracujących nad kodem PyTorch, którzy chcą utrzymać spójność dokumentacji w całym projekcie.

1. Zainstaluj umiejętność w swoim środowisku Claude/Copilot, wskazując repozytorium PyTorch i ścieżkę .claude/skills/docstring. 2. Otwórz plik Python zawierający funkcję lub metodę, dla której chcesz napisać docstring. 3. Umieść kursor na linii przed funkcją i poproś Claude o wygenerowanie docstringa, podając nazwę funkcji oraz jej parametry i typ zwracany. 4. Claude wygeneruje docstring w formacie raw string (r"""...""") z sygnaturą funkcji, krótkim opisem i przykładami użycia. 5. Jeśli funkcja zawiera operacje matematyczne, docstring automatycznie doda dyrektywy Sphinx (:math:) dla formuł. 6. Przejrzyj wygenerowany tekst, upewnij się, że zawiera odnośniki do powiązanych funkcji (:func:, :class:, :meth:) i dostosuj je do struktury projektu, jeśli jest to konieczne.