docs: clean up class docstrings in agents, models, memories#3880
docs: clean up class docstrings in agents, models, memories#3880iFiras-Max1 wants to merge 6 commits intocamel-ai:masterfrom
Conversation
Move Args from __init__ to class-level docstrings, replace Attributes with Args where needed, and fix :str: references to use :obj: consistently. Part of camel-ai#911
- stub_model: add class docstrings for StubTokenCounter and StubModel - model_manager: fix :str: -> :obj: in scheduling_strategy default - base_audio_model: add Args section - openai_audio_models: add Args section Part of camel-ai#911
Replace Attributes with Args, add missing default values, and expand ContextRecord docstring. Part of camel-ai#911
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
fengju0213
left a comment
fengju0213
left a comment
There was a problem hiding this comment.
thanks ！@iFiras-Max1
We'd better stay completely consistent with the original annotations.
- Reverted docstring rewrites in agents/ — keeping original text as-is per review - Reverted Attributes → Args renames (stays consistent with existing style) - Kept new Args sections where none existed (audio models, stub, records) - Kept :str: → :obj: fix in model_manager - Added missing docstrings for StubTokenCounter and ProcessingMode
|
Thanks @fengju0213 .. fair point, I went too far with the rewrites. Scoped it down now:
No original text touched anymore.. just additions. |
|
@Wendong-Fan I've updated the PR based on the review — scoped it down to additions only. Ready for another look whenever you're free! |
3 participants
Noticed several classes across core modules had inconsistent or missing docstrings while reading through the codebase. This cleans them up to follow the project's format from #911.
What changed:
Argsfrom__init__to class-level docstrings where they were duplicated (KnowledgeGraphAgent,MCPAgent)AttributeswithArgsfor constructor parameters (RepoAgent,MemoryRecord, etc.):str:references to use:obj:consistently (MCPAgent,ModelManager)ProcessingMode,StubTokenCounter,ContextRecord)Argssections to classes that were missing them (BaseAudioModel,OpenAIAudioModels,StubModel)Files: 9 files across
agents/,models/,memories/No logic changes — docstrings only.
Relates to #911