Skip to content

docs(scheduler): align docstrings with the real signatures - #2391

Open
simpleqt wants to merge 1 commit into
MemTensor:mainfrom
simpleqt:sq919/scheduler-docstrings
Open

docs(scheduler): align docstrings with the real signatures#2391
simpleqt wants to merge 1 commit into
MemTensor:mainfrom
simpleqt:sq919/scheduler-docstrings

Conversation

@simpleqt

@simpleqt simpleqt commented Sep 19, 2026

Copy link
Copy Markdown

Three docstrings in mem_scheduler document parameters that do not exist in the signatures (AST-verified):

  1. SchedulerOrchestrator.init(self) — takes no arguments, but the docstring has an Args block for queue: An instance of SchedulerRedisQueue. Replaced with a plain one-line summary.
  2. QueryMonitorQueue.to_json(self) / from_json(cls, json_str) — docstrings document item_serializer / item_deserializer optional callables; neither is a parameter (items are serialized directly via item.to_json()). Dropped the phantom entries.
  3. RedisTaskQueue — the Args section documents both the real max_len and a stale maxsize (for Queue compatibility, ignored) entry; no maxsize parameter exists. Dropped the stale line.

Docs-only change.

Related Issue: N/A (docs-only fix)

@simpleqt
docs(scheduler): align docstrings with the real signatures
800df99 
- SchedulerOrchestrator.__init__ takes no arguments; drop the phantom
  'queue' Args block
- QueryMonitorQueue.to_json/from_json take no serializer arguments; drop
  the phantom 'item_serializer'/'item_deserializer' Args entries
- RedisTaskQueue documents both 'max_len' and a stale 'maxsize' entry;
  drop the stale one (no maxsize parameter exists)
Copilot AI lite review requested due to automatic review settings September 19, 2026 08:01
@Memtensor-AI Memtensor-AI added area:scheduler 调度模块 status:in-progress Someone or AI is working on it | 人工或 AI 正在处理 labels Sep 19, 2026
Copilot AI reviewed Sep 19, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@Memtensor-AI

Memtensor-AI commented Sep 19, 2026

Copy link
Copy Markdown
Collaborator

🤖 Open Code Review

Target: PR #2391
Task: aa8083a926418bee
Base: main
Head: sq919/scheduler-docstrings

✅ OpenCodeReview: Review complete: 0 finding(s) across 3 selected item(s).

Generated by cloud-assistant via Open Code Review.

@Memtensor-AI

Memtensor-AI commented Sep 19, 2026

Copy link
Copy Markdown
Collaborator

✅ Automated Test Results: PASSED

All tests passed (4/4 executed). memos_python_core/changed-python-source: 4/4. Duration: 8s

Branch: sq919/scheduler-docstrings

@Memtensor-AI Memtensor-AI added status:ready Ready for implementation; waiting for assignee or AI dispatch | 可进入实现，等待认领或派发 and removed status:in-progress Someone or AI is working on it | 人工或 AI 正在处理 labels Sep 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@wustzdy wustzdy Awaiting requested review from wustzdy

At least 1 approving review is required to merge this pull request.

Assignees

@hijzy hijzy

Labels

area:scheduler 调度模块 status:ready Ready for implementation; waiting for assignee or AI dispatch | 可进入实现，等待认领或派发

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@simpleqt @Memtensor-AI @hijzy