Treść książki
Przejdź do opcji czytnikaPrzejdź do nawigacjiPrzejdź do informacjiPrzejdź do stopki
Googlemaswójwłasnyformatorazświetnyprzewodnik.Niektórzyczłonko-
wiespołecznościnaukowejstosująstandarddocstringonazwieNumPy.Również
reStructuredTextjestpopularnymformatem,używanymgłówniewpołączeniu
znarzędziemSphinx,którewykorzystujeciągidocstringdogenerowaniado-
kumentacjidlaprojektówwPythoniewformatachHTMLiPDF.Ktoś,kto
kiedykolwiekczytałdokumentację(https://readthedocs.org/)dlajakiegośmodu-
łuPython,widziałnarzędzieSphinxwakcji.Łączaprowadzącedowytycz-
nychdlaniektórychztychróżnychstylówznajdująsięwczęścifiMateriały
dodatkowe”,nastronie15.
Abysprawdzić,wjakimstopniunaszeciągidocstringspełniająwymaga-
niakonwencjiPEP257,możemyposłużyćsiędarmowymnarzędziemona-
zwiepydocstyle.AbyzainstalowaćjewsystemieWindowslubdowolnyminnym
systemieoperacyjnym,należyotworzyćoknowierszapoleceniaiwpisać
pipinstallpydocstyle(jeśliPythonzainstalowanyjestzarównowwersji2,
jakiwersji3,tonależyużyćnarzędziapip3).
Abyuruchomićnarzędziepydocstyle,otwieramywierszpoleceniawfol-
derzezawierającymkod,którychcemysprawdzić.Jeśliniepodamynazwypli-
ku,pydocstylezostanieuruchomionydlawszystkichprogramówwPythonie
dostępnychwtymfolderzeiotrzymamytakiwynik:
C:\Python35\Python3Stuff\Psych>pydocstyle
.\OLD-pseudonyms-main.py:1atmodulelevel:
D100:Missingdocstringinpublicmodule
.\OLD-pseudonyms-main.py:4inpublicfunction`main`:
D103:Missingdocstringinpublicfunction
.\pseudonyms.py:1atmodulelevel:
D100:Missingdocstringinpublicmodule
.\pseudonyms-main-broken.py:1atmodulelevel:
D200:One-linedocstringshouldfitononelinewithquotes(found2)
.\pseudonyms-main-broken.py:6inpublicfunction`main`:
D205:1blanklinerequiredbetweensummarylineanddescription
(found0)
Jeślipodamyplik,wktórymniemażadnychproblemówzciągami
docstring,pydocstyleniezwrócinamniczego:
C:\Python35\Python3Stuff\Psych>pydocstylepseudonyms_main_fixed.py
C:\Python35\Python3Stuff\Psych>
Wewszystkichprojektachwtejksiążceużywaćbędziemystosunkowopro-
stychciągówdocstring,abyzredukowaćwtensposóbwizualnyszumwopa-
trzonymopisemkodzie.Jeślichcesz,możeszjebezprzeszkódrozbudowywać,
abyjewtensposóbprzećwiczyć.Uzyskanerezultatyzawszemożnasprawdzić
zapomocąnarzędziapydocstyle.
Sprawdzaniestylunaszegokodu
Gdydorastałem,mójwujekdojeżdżałznaszegomiasteczkadowiększego
miasta,abymiejscowyfryzjerfiwystylizował”jegowłosy.Nigdynierozumia-
łem,czymróżnisiętoodzwykłegostrzyżenia,alewiemnatomiast,wjaki
12Rozdział:1
