Conversation
- Fix numbering format in migration guide (6. instead of 6) - Fix typo: 'subsituted' -> 'substituted' - Correct field name in JSON examples: 'call_template' -> 'tool_call_template' - Update migration guide description to use correct field name - Ensure consistency between documentation and actual implementation
docs: fix README inconsistencies and typos
…atch-3 Update README.md
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
|
|
||
| class TextCommunicationProtocol(CommunicationProtocol): | ||
| """Communication protocol for file-based UTCP manuals and tools.""" | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstring includes placeholder text 'REQUIRED'; remove it so the summary is clean and suitable for generated docs.
Prompt for AI agents
Address the following comment on plugins/communication_protocols/text/src/utcp_text/text_communication_protocol.py at line 29:
<comment>Docstring includes placeholder text 'REQUIRED'; remove it so the summary is clean and suitable for generated docs.</comment>
<file context>
@@ -26,7 +26,8 @@
logger = logging.getLogger(__name__)
class TextCommunicationProtocol(CommunicationProtocol):
- """Communication protocol for file-based UTCP manuals and tools."""
+ """REQUIRED
+ Communication protocol for file-based UTCP manuals and tools."""
</file context>
|
|
||
| class DefaultVariableSubstitutor(VariableSubstitutor): | ||
| """Default implementation of variable substitution. | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstring starts with a placeholder 'REQUIRED' instead of a meaningful one-line summary.
Prompt for AI agents
Address the following comment on core/src/utcp/implementations/default_variable_substitutor.py at line 22:
<comment>Docstring starts with a placeholder 'REQUIRED' instead of a meaningful one-line summary.</comment>
<file context>
@@ -19,7 +19,8 @@
from utcp.data.utcp_client_config import UtcpClientConfig
class DefaultVariableSubstitutor(VariableSubstitutor):
- """Default implementation of variable substitution.
+ """REQUIRED
+ Default implementation of variable substitution.
</file context>
|
|
||
| class ApiKeyAuth(Auth): | ||
| """Authentication using an API key. | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstring starts with placeholder 'REQUIRED' instead of a one-line summary; violates standard docstring conventions and may impact doc generation.
Prompt for AI agents
Address the following comment on core/src/utcp/data/auth_implementations/api_key_auth.py at line 8:
<comment>Docstring starts with placeholder 'REQUIRED' instead of a one-line summary; violates standard docstring conventions and may impact doc generation.</comment>
<file context>
@@ -5,7 +5,8 @@
from utcp.exceptions import UtcpSerializerValidationError
class ApiKeyAuth(Auth):
- """Authentication using an API key.
+ """REQUIRED
+ Authentication using an API key.
</file context>
|
|
||
| class OAuth2Auth(Auth): | ||
| """Authentication using OAuth2 client credentials flow. | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstrings begin with a 'REQUIRED' placeholder instead of a meaningful summary; replace the placeholder with an appropriate summary to improve documentation clarity.
Prompt for AI agents
Address the following comment on core/src/utcp/data/auth_implementations/oauth2_auth.py at line 9:
<comment>Docstrings begin with a 'REQUIRED' placeholder instead of a meaningful summary; replace the placeholder with an appropriate summary to improve documentation clarity.</comment>
<file context>
@@ -6,7 +6,8 @@
class OAuth2Auth(Auth):
- """Authentication using OAuth2 client credentials flow.
+ """REQUIRED
+ Authentication using OAuth2 client credentials flow.
</file context>
|
|
||
| class VariableLoader(BaseModel, ABC): | ||
| """Abstract base class for variable loading configurations. | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstrings start with the placeholder 'REQUIRED' instead of a clear one-line summary; replace the placeholder or move the summary to the first line to follow PEP 257 and maintain documentation quality.
Prompt for AI agents
Address the following comment on core/src/utcp/data/variable_loader.py at line 10:
<comment>Docstrings start with the placeholder 'REQUIRED' instead of a clear one-line summary; replace the placeholder or move the summary to the first line to follow PEP 257 and maintain documentation quality.</comment>
<file context>
@@ -7,7 +7,8 @@
import traceback
class VariableLoader(BaseModel, ABC):
- """Abstract base class for variable loading configurations.
+ """REQUIRED
+ Abstract base class for variable loading configurations.
</file context>
|
|
||
| class HttpCallTemplate(CallTemplate): | ||
| """Provider configuration for HTTP-based tools. | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstring should begin with the summary sentence; avoid using 'REQUIRED' as a standalone first line. Move the summary to the first line and format per docstring conventions.
Prompt for AI agents
Address the following comment on plugins/communication_protocols/http/src/utcp_http/http_call_template.py at line 10:
<comment>Docstring should begin with the summary sentence; avoid using 'REQUIRED' as a standalone first line. Move the summary to the first line and format per docstring conventions.</comment>
<file context>
@@ -7,7 +7,8 @@
from pydantic import Field
class HttpCallTemplate(CallTemplate):
- """Provider configuration for HTTP-based tools.
+ """REQUIRED
+ Provider configuration for HTTP-based tools.
</file context>
|
|
||
| class CommunicationProtocol(ABC): | ||
| """Abstract interface for UTCP client transport implementations. | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstrings start with 'REQUIRED' instead of a summary line, violating docstring conventions and reducing documentation quality.
Prompt for AI agents
Address the following comment on core/src/utcp/interfaces/communication_protocol.py at line 16:
<comment>Docstrings start with 'REQUIRED' instead of a summary line, violating docstring conventions and reducing documentation quality.</comment>
<file context>
@@ -13,7 +13,8 @@
from utcp.utcp_client import UtcpClient
class CommunicationProtocol(ABC):
- """Abstract interface for UTCP client transport implementations.
+ """REQUIRED
+ Abstract interface for UTCP client transport implementations.
</file context>
|
|
||
| class SseCallTemplate(CallTemplate): | ||
| """Provider configuration for Server-Sent Events (SSE) tools. | ||
| """REQUIRED |
Contributor
There was a problem hiding this comment.
Docstring should start with a concise summary; using 'REQUIRED' as the first line violates docstring conventions.
Prompt for AI agents
Address the following comment on plugins/communication_protocols/http/src/utcp_http/sse_call_template.py at line 10:
<comment>Docstring should start with a concise summary; using 'REQUIRED' as the first line violates docstring conventions.</comment>
<file context>
@@ -7,7 +7,8 @@
from pydantic import Field
class SseCallTemplate(CallTemplate):
- """Provider configuration for Server-Sent Events (SSE) tools.
+ """REQUIRED
+ Provider configuration for Server-Sent Events (SSE) tools.
</file context>
| if self.is_required_docstring(method_docstring): | ||
| signature = self.get_function_signature(item) | ||
| if signature.__contains__('find_required_variables'): | ||
| print("test") |
Contributor
There was a problem hiding this comment.
Remove stray debug print left from debugging.
Prompt for AI agents
Address the following comment on scripts/extract_required_docs.py at line 386:
<comment>Remove stray debug print left from debugging.</comment>
<file context>
@@ -0,0 +1,966 @@
+#!/usr/bin/env python3
+"""
+Script to extract REQUIRED docstrings from UTCP codebase and generate Docusaurus documentation.
+
+This script scans all Python files in core/ and plugins/ directories, extracts docstrings
+that start with "REQUIRED", and generates organized Docusaurus markdown files.
+"""
+
+import ast
</file context>
| return processed | ||
|
|
||
| if docstring.__contains__('{VAR}'): | ||
| print("") |
Contributor
There was a problem hiding this comment.
Remove stray debug print that outputs a blank line during docstring processing.
Prompt for AI agents
Address the following comment on scripts/extract_required_docs.py at line 203:
<comment>Remove stray debug print that outputs a blank line during docstring processing.</comment>
<file context>
@@ -0,0 +1,966 @@
+#!/usr/bin/env python3
+"""
+Script to extract REQUIRED docstrings from UTCP codebase and generate Docusaurus documentation.
+
+This script scans all Python files in core/ and plugins/ directories, extracts docstrings
+that start with "REQUIRED", and generates organized Docusaurus markdown files.
+"""
+
+import ast
</file context>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by cubic
Standardized REQUIRED docstrings across core and plugins and added an automated extractor to generate Docusaurus docs. Also fixed README typos and migration guide inconsistencies.
New Features
Bug Fixes