blu3-bird/Shopping-on-tuesday

🐕Add Documentation and Docstrings to Route Files

Aberta

#102 aberto em 18 de jan. de 2026

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)CSS (16 forks)auto 404
documentationhelp wanted🐭good first issue🦕Documentation🫎enhancement

Métricas do repositório

Stars
 (5 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

📚 Issue: Add Documentation and Docstrings to Route Files

Labels: documentation refactor good first issue

📌 Description

The route files currently lack clear documentation, making them harder to understand and maintain.

📂 Affected Files

  • app/admin/routes.py
  • app/main/routes.py
  • app/models.py

🎯 Objectives

  • Add meaningful docstrings to route functions
  • Explain the purpose of major routes and helpers
  • Improve readability without changing existing functionality

🎯 Purpose

Enhances code clarity, improves maintainability, and makes onboarding easier for new contributors.

Guia do colaborador

Direção de pesquisa
Revise os arquivos de rota afetados e adicione docstrings no estilo Google para cada função, descrevendo seu propósito, argumentos e valores de retorno.
Pilha de tecnologia
pythonflask
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Basic PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85