docs(societies): unify docstrings to CAMEL standard - #4307
mrsparkle-70 wants to merge 2 commits into
Conversation
|
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: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
|
Note on CI failures: the 7 failing checks are pre-existing upstream issues unrelated to this PR (which is docstrings-only):
|
|
I opened #4308 which fixes the root cause of the collection-time failures on this PR. Finding: all Verified on PR #4308's CI: the |
Description
This PR standardizes the docstrings in the
camel/societies/scope as part of #911.Changes:
r"""prefix,Attributes:sections following the style used for pydantic models elsewhere in the codebase, e.g.MemoryRecord) to all 14 event classesr"""prefixes on 14 methods; documentedWorkforceSnapshotconstructor params in the class docstringArgs:section per the guideliner"""prefixes on 10PipelineTaskBuildermethods (Args/Returns sections already present)Args:section into the class docstring per guideline point 8 (pattern matchesBaseModelBackend), fixed raw prefixNo runtime behavior is changed — docstrings only.
Testing
WorkforceLoggerinstantiation,PipelineTaskBuilderadd/fork/join/build chaining, event instantiationtest/workforce/suite before and after the change with identical results (34 passed; the 15 failures are pre-existing on master and require live LLM API access), confirming no regressionsRefs #911