|
8 | 8 | # ============================================================================= |
9 | 9 | # NAMING CONVENTION GUIDE (Simplified patterns for consistency) |
10 | 10 | # ============================================================================= |
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) | |
21 | 25 | # ============================================================================= |
22 | 26 |
|
23 | 27 | # ============================================================================= |
|
0 commit comments