VibecoderMcSwaggins commited on
Commit
d5b800f
·
1 Parent(s): 3a2b22f

docs: Clarify config parameter behavior in factory.py

Browse files

Address CodeRabbit recommendation to document that the config
parameter is only used by simple and hierarchical modes.
Advanced mode uses settings.advanced_max_rounds instead.

Files changed (1) hide show
  1. src/orchestrators/factory.py +2 -0
src/orchestrators/factory.py CHANGED
@@ -72,6 +72,8 @@ def create_orchestrator(
72
  search_handler: The search handler (required for simple mode)
73
  judge_handler: The judge handler (required for simple mode)
74
  config: Optional configuration (max_iterations, timeouts, etc.)
 
 
75
  mode: "simple", "magentic", "advanced", or "hierarchical"
76
  Note: "magentic" is an alias for "advanced" (kept for backwards compatibility)
77
  api_key: Optional API key for advanced mode (OpenAI)
 
72
  search_handler: The search handler (required for simple mode)
73
  judge_handler: The judge handler (required for simple mode)
74
  config: Optional configuration (max_iterations, timeouts, etc.)
75
+ Note: This parameter is only used by simple and hierarchical modes.
76
+ Advanced mode uses settings.advanced_max_rounds instead.
77
  mode: "simple", "magentic", "advanced", or "hierarchical"
78
  Note: "magentic" is an alias for "advanced" (kept for backwards compatibility)
79
  api_key: Optional API key for advanced mode (OpenAI)