blu3-bird/Shopping-on-tuesday

🐕Add Documentation and Docstrings to Route Files

Open

#102 opened on Jan 18, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)CSS (16 forks)auto 404
documentationhelp wanted🐭good first issue🦕Documentation🫎enhancement

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Review the affected route files and add Google style docstrings to each function, describing its purpose, arguments, and return values.
Tech stack
pythonflask
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85