PEP 8 na documentação
Até agora, a gente focou em como o PEP 8 afeta partes funcionais do código. Também tem regras pra ajudar a deixar os comentários e a documentação mais fáceis de ler. Neste exercício, você vai corrigir vários tipos de comentários para que estejam em conformidade com o PEP 8.
O resultado de uma verificação de estilo do código pelo pycodestyle pode ser visto abaixo.
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)
Este exercício faz parte do curso
Princípios de Engenharia de Software em Python
Instruções do exercício
- Use o resultado de
pycodestylepara editar os comentários do código e deixá-los em conformidade com o PEP 8.
Exercício interativo prático
Experimente este exercício completando este código de exemplo.
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)