PEP 8 en la documentación
Hasta ahora nos hemos centrado en cómo afecta PEP 8 a las partes funcionales del código. También hay reglas para ayudar a que los comentarios y la documentación sean más legibles. En este ejercicio, corregirás varios tipos de comentarios para que cumplan con la norma PEP 8.
El resultado de una comprobación del estilo del código con pycodestyle se puede ver a continuación.
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 ejercicio forma parte del curso
Principios de ingeniería de software en Python
Instrucciones del ejercicio
- Aprovecha el resultado de
pycodestylepara editar los comentarios del código y que cumplan con PEP 8.
Ejercicio interactivo práctico
Prueba este ejercicio y completa el código de muestra.
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)