PEP 8 v dokumentaci

Dosud jsme se zaměřovali na to, jak PEP 8 ovlivňuje funkční části kódu. Existují ale také pravidla, která pomáhají zpřehlednit komentáře a dokumentaci. V tomto cvičení upravíš různé typy komentářů tak, aby odpovídaly standardu PEP 8.

Výsledek kontroly stylu pomocí pycodestyle vidíš níže.

my_script.py:2:15: E261 at least two spaces before inline comment
my_script.py:5:16: E262 inline comment should start with '# '
my_script.py:11:1: E265 block comment should start with '# '
my_script.py:13:2: E114 indentation is not a multiple of four (comment)
my_script.py:13:2: E116 unexpected indentation (comment)

Toto cvičení je součástí kurzu

Principy softwarového inženýrství v Pythonu

Zobrazit kurz

Pokyny k cvičení

Využij výstup pycodestyle a uprav komentáře v kódu tak, aby splňovaly pravidla PEP 8.

Interaktivní cvičení na vyzkoušení si v praxi

Vyzkoušejte si toto cvičení dokončením tohoto ukázkového kódu.

def print_phrase(phrase, polite=True, shout=False):
    if polite:# It's generally polite to say please
        phrase = 'Please ' + phrase

    if shout:  #All caps looks like a written shout
        phrase = phrase.upper() + '!!'

    print(phrase)


#Politely ask for help
print_phrase('help me', polite=True)
 # Shout about a discovery
print_phrase('eureka', shout=True)

Upravit a spustit kód