Skip to content

MIGUEL - Mejora en documentación y simplificación de comentarios en task.py #48

Description

@EstevenMarchand06

Actualmente:

  • No existe un comentario general al inicio del archivo que explique su propósito.
  • Algunos comentarios son demasiado extensos y complejos.
  • Existen comentarios con líneas innecesarias o uso excesivo de comillas.
  • La redacción podría simplificarse para mejorar la comprensión.

Observaciones

Falta agregar un comentario inicial que describa que el archivo:

  • Contiene la lógica principal para manejar tareas.
  • Incluye funciones para agregar, listar, completar y eliminar tareas.

Algunos comentarios actuales:

  • Son demasiado largos o técnicos.
  • Incluyen explicaciones que pueden resumirse.
  • Usan líneas innecesarias que afectan la legibilidad.
  • No están redactados de forma simple y accesible.

Propuesta de mejora

  • Agregar un comentario general al inicio del archivo explicando su función principal.
  • Simplificar los comentarios existentes.
  • Eliminar líneas innecesarias.
  • Redactar comentarios más claros, directos y comprensibles para cualquier miembro del equipo.

Criterios de aceptación

  • Se agrega comentario general al inicio del archivo.
  • Los comentarios extensos son simplificados.
  • Se eliminan líneas innecesarias.
  • La documentación queda clara, limpia y accesible.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions