Skip to content

refactor: collapse docstrings to single-line format - #31

Open
deepsource-autofix[bot] wants to merge 2 commits into
mainfrom
deepsource-autofix-7f80b485
Open

refactor: collapse docstrings to single-line format#31
deepsource-autofix[bot] wants to merge 2 commits into
mainfrom
deepsource-autofix-7f80b485

Conversation

@deepsource-autofix

Copy link
Copy Markdown
Contributor

This PR refactors docstrings across the ARF codebase to ensure they fit on a single line enclosed within triple quotes, as required by the project's documentation style guide. Multi-line docstrings that spanned opening, description, and closing lines have been consolidated into one-line formats for consistency, readability, and maintainability.

  • One-line docstring should fit on one line with quotes: DeepSource flagged that many docstrings were written as three separate lines (opening quotes, content, closing quotes), which violates the one-line docstring rule. Each affected docstring has been collapsed into a single line enclosed within triple quotes, improving code clarity and aligning with the style guide.

This Autofix was generated by AI. Please review the change before merging.

This PR refactors docstrings across the ARF codebase to ensure they fit on a single line enclosed within triple quotes, as required by the project's documentation style guide. Multi-line docstrings that spanned opening, description, and closing lines have been consolidated into one-line formats for consistency, readability, and maintainability.

- One-line docstring should fit on one line with quotes: DeepSource flagged that many docstrings were written as three separate lines (opening quotes, content, closing quotes), which violates the one-line docstring rule. Each affected docstring has been collapsed into a single line enclosed within triple quotes, improving code clarity and aligning with the style guide.

> This Autofix was generated by AI. Please review the change before merging.
@vercel

vercel Bot commented Apr 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
floss Ready Ready Preview, Comment, Open in v0 Apr 21, 2026 10:26pm

This commit fixes the style issues introduced in ab40dfb according to the output
from Black and Rustfmt.

Details: #31
@deepsource-io

deepsource-io Bot commented Apr 21, 2026

Copy link
Copy Markdown

DeepSource Code Review

We reviewed changes in 28f41f0...f6baacc on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade  

Focus Area: Hygiene
Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
Python Apr 21, 2026 10:26p.m. Review ↗
Rust Apr 21, 2026 10:26p.m. Review ↗
Secrets Apr 21, 2026 10:26p.m. Review ↗

Important

AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.

Comment thread ARF/governance/budget.py
self.state = self._load_state()
logger.info(f"Initialized BudgetManager for {agent_id}. Used: {self.state.tokens_used} tokens.")
logger.info(
f"Initialized BudgetManager for {agent_id}. Used: {self.state.tokens_used} tokens."

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

line too long (95 > 88 characters)


Line length greater than configured max_line_length detected, defaults to 79 character. This limit can be configured docs

Comment thread ARF/governance/budget.py
raise BudgetExceededError(f"Token limit exceeded: {self.state.tokens_used}/{self.config.max_tokens_per_session}")

raise BudgetExceededError(
f"Token limit exceeded: {self.state.tokens_used}/{self.config.max_tokens_per_session}"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

line too long (102 > 88 characters)


Line length greater than configured max_line_length detected, defaults to 79 character. This limit can be configured docs

Comment thread ARF/governance/budget.py
if self.state.estimated_cost >= self.config.max_cost_per_session:
raise BudgetExceededError(f"Cost limit exceeded: ${self.state.estimated_cost}/${self.config.max_cost_per_session}")
raise BudgetExceededError(
f"Cost limit exceeded: ${self.state.estimated_cost}/${self.config.max_cost_per_session}"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

line too long (104 > 88 characters)


Line length greater than configured max_line_length detected, defaults to 79 character. This limit can be configured docs

Comment thread ARF/ontology/mixing.py
def mix(self, pattern_a: InteractionPattern, pattern_b: InteractionPattern, strategy: str = "interleave") -> InteractionPattern:
"""Mixes two interaction patterns to create a new hybrid pattern."""

def mix(

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Method doesn't use the class instance and could be converted into a static method


The method doesn't use its bound instance. Decorate this method with @staticmethod decorator, so that Python does not have to instantiate a bound method for every instance of this class thereby saving memory and computation. Read more about staticmethods here.

Comment thread ARF/ontology/patterns.py
}
)

matches.sort(key=lambda x: x["confidence"], reverse=True)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Incompatible return value type (got "object", expected "Union[SupportsDunderLT, SupportsDunderGT]")


The return type of this callable is different from what is defined in the type hint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants