mirror of
https://github.com/marcogll/talia_bot.git
synced 2026-01-13 21:35:19 +00:00
docs: Add comprehensive comments and update README
This commit adds detailed inline comments and docstrings to all modules within the `app/modules/` directory to improve code clarity, readability, and maintainability. It also updates the `README.md` file to include `create_tag.py` and `print.py` in the "Módulos Funcionales" section, ensuring the documentation is synchronized with the codebase.
This commit is contained in:
@@ -1,8 +1,20 @@
|
||||
# app/modules/servicios.py
|
||||
"""
|
||||
This module is responsible for providing information about the services offered.
|
||||
|
||||
It's a simple informational module that gives clients an overview of the
|
||||
available services and can be expanded to provide more detailed information
|
||||
or initiate a quoting process.
|
||||
"""
|
||||
|
||||
def get_service_info():
|
||||
"""
|
||||
Provides information about available services.
|
||||
Provides a brief overview of the available services.
|
||||
|
||||
Currently, this function returns a hardcoded list of services. For a more
|
||||
dynamic and easily maintainable system, this information could be fetched
|
||||
from a database, a configuration file, or an external API.
|
||||
"""
|
||||
# TODO: Fetch service details from a database or config file
|
||||
# TODO: Fetch service details from a database or a configuration file to
|
||||
# make the service list easier to manage and update.
|
||||
return "Ofrecemos una variedad de servicios, incluyendo:\n\n- Consultoría Estratégica\n- Desarrollo de Software\n- Talleres de Capacitación\n\n¿Sobre cuál te gustaría saber más?"
|
||||
|
||||
Reference in New Issue
Block a user