Skip to content

Commit 1b43dc6

Browse files
committed
Update naming convention guide with list_X pattern and clarify decorator usage
1 parent 929cefa commit 1b43dc6

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

src/praisonai-agents/praisonaiagents/__init__.py

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,20 @@
88
# =============================================================================
99
# NAMING CONVENTION GUIDE (Simplified patterns for consistency)
1010
# =============================================================================
11-
# | Pattern | When to Use | Examples |
12-
# |-------------|----------------------|-----------------------------------|
13-
# | add_X | Register something | add_hook, add_tool |
14-
# | get_X | Retrieve something | get_tool, get_registry |
15-
# | remove_X | Unregister something | remove_hook, remove_tool |
16-
# | has_X | Check existence | has_hook, has_tool |
17-
# | enable_X | Turn on feature | enable_telemetry |
18-
# | disable_X | Turn off feature | disable_telemetry |
19-
# | XConfig | Configuration class | MemoryConfig, HooksConfig |
20-
# | @verb | Decorator | @tool, @before_model |
11+
# | Pattern | When to Use | Examples |
12+
# |---------------|-------------------------|----------------------------------|
13+
# | add_X | Register something | add_hook, add_tool, add_profile |
14+
# | get_X | Retrieve something | get_tool, get_profile |
15+
# | remove_X | Unregister something | remove_hook, remove_tool |
16+
# | has_X | Check existence | has_hook, has_tool |
17+
# | list_X | List all items | list_tools, list_profiles |
18+
# | enable_X | Turn on feature | enable_telemetry |
19+
# | disable_X | Turn off feature | disable_telemetry |
20+
# | XConfig | Configuration class | MemoryConfig, HooksConfig |
21+
# | @decorator | Decorator | @tool, @add_hook |
22+
# |---------------|-------------------------|----------------------------------|
23+
# | set_default_X | Internal/advanced only | (don't simplify - internal) |
24+
# | create_X | Factory function | (already well-named) |
2125
# =============================================================================
2226

2327
# =============================================================================

0 commit comments

Comments
 (0)