devseniorlabpython/hardware-shop
Añadir Docstrings y Type Hinting a las Funciones de `main.py`
Open
#5 opened on Aug 8, 2025
documentationgood first issue
Repository metrics
- Stars
- (0 stars)
- PR merge metrics
- (PR metrics pending)
Description
Un código de alta calidad no solo funciona, sino que también es fácil de leer y entender para otros desarrolladores. Los docstrings (cadenas de documentación) y type hints (pistas de tipo) son fundamentales para lograrlo.
Tu Misión:
Revisar el archivo main.py y asegurarse de que todas las funciones tengan docstrings claros y que sus parámetros y valores de retorno estén correctamente tipados.
Tareas Específicas:
-
Revisar
mostrar_menu():- Esta función ya tiene un buen docstring. ¡Úsalo como ejemplo!
- Asegúrate de que su definición incluya el tipo de retorno:
def mostrar_menu() -> None:.Nonese usa porque la función no devuelve ningún valor, solo imprime en pantalla.
-
Revisar
main():- Añade un docstring que explique el propósito general de la función (ej. "Función principal que inicia el bucle del menú y gestiona la interacción del usuario.").
- Añade el tipo de retorno
-> Nonea su definición.
-
Revisar el Bloque
if __name__ == "__main__"::- Añade un comentario simple encima de este bloque explicando por qué está ahí (ej.
# Punto de entrada para ejecutar la aplicación.).
- Añade un comentario simple encima de este bloque explicando por qué está ahí (ej.
¿Por qué es importante?
- Docstrings: Permiten que herramientas como VS Code muestren ayuda contextual sobre una función cuando pasas el ratón por encima. También son usados por generadores de documentación automática.
- Type Hints: Ayudan a prevenir errores al permitir que los analizadores de código estático (como el que usa VS Code) detecten si estás pasando un tipo de dato incorrecto a una función.
Objetivos de Aprendizaje:
- Escribir documentación clara y concisa siguiendo los estándares de Python (PEP 257).
- Utilizar el sistema de tipado estático de Python (PEP 484).
- Entender la diferencia entre un comentario (
#) y un docstring ("""..."""). - Mejorar la