Skip to content

docs: Add type hints and improve documentation in settings.py#1112

Open
hiSandog wants to merge 1 commit intolangflow-ai:mainfrom
hiSandog:fix/type-hints-and-docs
Open

docs: Add type hints and improve documentation in settings.py#1112
hiSandog wants to merge 1 commit intolangflow-ai:mainfrom
hiSandog:fix/type-hints-and-docs

Conversation

@hiSandog
Copy link

Summary

This PR improves code quality by adding comprehensive type hints and documentation to the settings.py configuration file.

Changes

  • Added type hints to all public and private methods in AppClients class
  • Improved docstrings with proper Args and Returns sections following Google style
  • Fixed inconsistent indentation in OPENAI_EMBEDDING_DIMENSIONS and WATSONX_EMBEDDING_DIMENSIONS dictionaries
  • Simplified is_no_auth_mode() function for better readability
  • Added class-level docstring for AppClients

Benefits

  • Better IDE autocomplete and type checking support
  • Improved code maintainability and readability
  • Clearer documentation for contributors
  • Consistent code style

Testing

  • No functional changes, only type hints and documentation improvements
  • All existing functionality remains unchanged

- Added type hints to all public and private methods
- Improved docstrings with Args and Returns sections
- Fixed inconsistent indentation in dictionary definitions
- Simplified is_no_auth_mode() function
- Added class docstring for AppClients
@github-actions github-actions bot added community backend 🔷 Issues related to backend services (OpenSearch, Langflow, APIs) documentation 📘 Improvements or additions to documentation labels Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend 🔷 Issues related to backend services (OpenSearch, Langflow, APIs) community documentation 📘 Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant