thwap/kronai
Watch
4
0
Fork
You've already forked kronai
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

mcp: fix docstring format for Raises/Returns sections #89

New issue
Closed
opened 2026-07-05 14:13:31 +00:00 by the.auditor · 1 comment
the.auditor commented 2026-07-05 14:13:31 +00:00
Owner
Copy link

connect() and get_tools() in src/kronai/mcp.py use Raises/Returns without trailing colon in docstrings. Inconsistent with the rest of the codebase which uses numpy-style with colons (e.g., Raises:).

From PR #88 review suggestion.

`connect()` and `get_tools()` in `src/kronai/mcp.py` use `Raises`/`Returns` without trailing colon in docstrings. Inconsistent with the rest of the codebase which uses numpy-style with colons (e.g., `Raises:`). _From PR #88 review suggestion._
automation commented 2026-07-05 17:42:16 +00:00
Owner
Copy link

This suggestion conflicts with the project's linter configuration. ruff's auto-fix (D406/D407 rules) enforces the no-colon format for Raises/Returns sections — adding colons causes the CI to fail. Closing as "won't fix" since the linter enforces the opposite convention.

See PR #132 which was closed after CI failed on this issue.

This suggestion conflicts with the project's linter configuration. ruff's auto-fix (D406/D407 rules) enforces the **no-colon** format for `Raises`/`Returns` sections — adding colons causes the CI to fail. Closing as "won't fix" since the linter enforces the opposite convention. See PR #132 which was closed after CI failed on this issue.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
fix/0089-mcp-docstring-format
No results found.
Labels
Clear labels   
Compat/Breaking
Breaking change that won't be backward compatible

  
Kind/Bug
Something is not working

  
Kind/Documentation
Documentation changes

  
Kind/Enhancement
Improve existing functionality

  
Kind/Feature
New functionality

  
Kind/Security
This is security issue

  
Kind/Testing
Issue or pull request related to testing

  
Priority
Critical
 The priority is critical

  
Priority
High
 The priority is high

  
Priority
Low
 The priority is low

  
Priority
Medium
 The priority is medium

  
Reviewed
Confirmed
 Issue has been confirmed

  
Reviewed
Duplicate
 This issue or pull request already exists

  
Reviewed
Invalid
 Invalid issue

  
Reviewed
Won't Fix
 This issue won't be fixed

  
Status
Abandoned
 Somebody has started to work on this but abandoned work

  
Status
Blocked
 Something is blocking this issue or pull request

  
Status
Need More Info
 Feedback is required to reproduce issue or to continue work

No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
thwap/kronai#89
No description provided.