devseniorlabpython / devseniorlabpython/hardware-shop

Añadir Docstrings y Type Hinting a las Funciones de `main.py`

未关闭 适合新手
#5 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation good first issue
主要语言
Python
星标
0
派生
4
PR 合并指标
30 天内没有已合并 PR

描述

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

贡献指南

这个仓库没有索引到贡献指南

调研方向

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.

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
85/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。