8
Tak, wydałem małą bibliotekę na pypi, bardziej jako ćwiczenie ("zobacz, jak to się robi") niż cokolwiek innego.Uwalnianie pakietu python - czy należy dołączyć dokument i testy?
Załadowałem dokumentację na readthedocs i mam zestaw testów w moim repozytorium git.
Ponieważ sądzę, że każdy, kto może być zainteresowany przeprowadzeniem testu, prawdopodobnie po prostu sklonuje repozytorium, a dokument jest już dostępny w Internecie, postanowiłem nie dołączać dokumentów i katalogów testowych do wydanego pakietu, a ja po prostu zastanawiasz się, czy to była "właściwa" rzecz.
Wiem, że odpowiedzi na to pytanie będą raczej subiektywne, ale czułem, że było to dobre miejsce, aby dowiedzieć się, co społeczność uważa za najlepszą praktykę.
Nie mogę znaleźć żadnych PEP ani sekcji dokumentacji Setuptools, które faktycznie mówią cokolwiek o testach i dokumentach, ale ogólny wzorzec jaki widzę, to to, że pakiety pakują testy i nie pakują dokumentacji. – Blender
Hmm. W pewnym sensie spodziewałem się czegoś odwrotnego - choć widzę, że warto uwzględnić dokumentację, z której można korzystać w trybie offline, wydaje mi się, że większość zwykłych użytkowników (tj. Ludzie, którzy po prostu zainstalują bibliotekę i użyją jej, zakładając, że po prostu działa, a nie ludzie zainteresowani hackowaniem twoich rzeczy) prawdopodobnie nigdy nie uruchomi uwzględnionych testów, więc ich łączenie wydaje mi się (pomijalne, ale wciąż) marnowaniem. Dzięki za odpowiedź tak czy inaczej :) – astrognocci
Dokumentacja dla tych pakietów jest generowana z kodu źródłowego tak czy inaczej, więc po prostu robisz 'help (funkcja)' i ta sama dokumentacja jest pobierana z docstringu metody lub modułu. – Blender