LCORE-1142: docstrings for app module

[tisnik]

Description

LCORE-1142: docstrings for app module

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Tools used to create PR

• Assisted-by: N/A
• Generated by: CodeRabbitAI

Related Tickets & Documents

• Related Issue #LCORE-1142

Summary by CodeRabbit

• Documentation
  • Enhanced internal API documentation with comprehensive docstring updates for database operations, middleware metrics, and router configuration to improve code clarity and maintainability.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Docstring expansions across three core modules—database, main, and routers—adding detailed parameter descriptions, return types, and exception information to existing public functions. No functional logic or control flow changes.

Changes

Cohort / File(s)	Summary
Database module docstrings src/app/database.py	Expanded docstrings for get_engine, create_tables, get_session, _create_sqlite_engine, _create_postgres_engine, and initialize_database with Returns and Raises sections; runtime behavior unchanged
Middleware and routing documentation src/app/main.py, src/app/routers.py	Updated REST API metrics middleware docstring describing behavior and include_routers docstring detailing router registration and URL prefixing; no functional changes

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: adding docstrings to the app module functions and methods across multiple files.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}