devseniorlabpython / devseniorlabpython/hardware-shop
Añadir Docstrings y Type Hinting a las Funciones de `main.py`
- Lenguaje dominante
- Python
- Estrellas
- 0
- Forks
- 4
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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:**
1. **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:`. `None` se usa porque la función no devuelve ningún valor, solo imprime en pantalla.
2. **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 `-> None` a su definición.
3. **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.`).
**¿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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Open main.py and review mostrar_menu(), main(), and the if __name__ == "__main__": block. Use the existing mostrar_menu() docstring as the style reference, then confirm that all functions have clear docstrings and type annotations for parameters and return values. Done means main() returns None in its annotation, the entry-point block has an explanatory comment, and the file remains runnable.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 85/100