Skip to content

Commit af77b58

Browse files
committed
fix: Some docs issues
1 parent dadcd9b commit af77b58

File tree

5 files changed

+7
-10
lines changed

5 files changed

+7
-10
lines changed

docs/api/generator.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1134,7 +1134,7 @@ openai_api = rg.HTTPGenerator.for_json_endpoint(
11341134
`None`
11351135
)
11361136
–Optional headers to include in the request.
1137-
Defaults to {"Content-Type": "application/json"}.
1137+
Defaults to "Content-Type": "application/json".
11381138
* **`auth`**
11391139
(`HttpAuthConfigDict | HttpAuthConfig | None`, default:
11401140
`None`
@@ -1230,7 +1230,7 @@ def for_json_endpoint(
12301230
api_key: Optional API key to use for authentication.
12311231
method: HTTP method to use (default is "POST").
12321232
headers: Optional headers to include in the request.
1233-
Defaults to {"Content-Type": "application/json"}.
1233+
Defaults to "Content-Type": "application/json".
12341234
auth: Optional authentication configuration for API key headers.
12351235
response: Optional configuration for parsing the response body.
12361236
valid_status_codes: List of valid HTTP status codes (default is [200]).
@@ -1359,7 +1359,7 @@ text_api = rg.HTTPGenerator.for_text_endpoint(
13591359
`None`
13601360
)
13611361
–Optional headers to include in the request.
1362-
Defaults to {"Content-Type": "text/plain"}.
1362+
Defaults to "Content-Type": "text/plain".
13631363
* **`auth`**
13641364
(`HttpAuthConfigDict | HttpAuthConfig | None`, default:
13651365
`None`
@@ -1442,7 +1442,7 @@ def for_text_endpoint(
14421442
api_key: Optional API key to use for authentication.
14431443
method: HTTP method to use (default is "POST").
14441444
headers: Optional headers to include in the request.
1445-
Defaults to {"Content-Type": "text/plain"}.
1445+
Defaults to "Content-Type": "text/plain".
14461446
auth: Optional authentication configuration for API key headers.
14471447
valid_status_codes: List of valid HTTP status codes (default is [200]).
14481448
timeout: Optional timeout in seconds for the request.

docs/api/watchers.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ If the history deviates, it treats it as a new conversation.
6464
`20`
6565
)
6666
–Max lines to display for content before shortening.
67-
* **`**kwargs`**
68-
–Additional arguments to pass to the Loguru logger.
6967

7068
**Returns:**
7169

@@ -91,7 +89,6 @@ def make_stream_to_logs(
9189
level: The Loguru log level to use.
9290
max_chars: Max characters to display for content before shortening.
9391
max_lines: Max lines to display for content before shortening.
94-
**kwargs: Additional arguments to pass to the Loguru logger.
9592
9693
Returns:
9794
An awaitable callback function for use with `ChatPipeline.watch()`.

docs/topics/tools.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,7 @@ async with rg.mcp("sse", url=MCP_SSE_URL) as mcp_client:
318318
else:
319319
print("No MCP tools found.")
320320
```
321+
</CodeGroup>
321322

322323
The `mcp` context manager handles the connection, tool discovery, and communication with the MCP server. Inside the `async with` block, `mcp_client.tools` provides the list of discovered `Tool` objects ready to be used with `.using()`.
323324

rigging/generator/http.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ def for_json_endpoint(
447447
api_key: Optional API key to use for authentication.
448448
method: HTTP method to use (default is "POST").
449449
headers: Optional headers to include in the request.
450-
Defaults to {"Content-Type": "application/json"}.
450+
Defaults to "Content-Type": "application/json".
451451
auth: Optional authentication configuration for API key headers.
452452
response: Optional configuration for parsing the response body.
453453
valid_status_codes: List of valid HTTP status codes (default is [200]).
@@ -538,7 +538,7 @@ def for_text_endpoint(
538538
api_key: Optional API key to use for authentication.
539539
method: HTTP method to use (default is "POST").
540540
headers: Optional headers to include in the request.
541-
Defaults to {"Content-Type": "text/plain"}.
541+
Defaults to "Content-Type": "text/plain".
542542
auth: Optional authentication configuration for API key headers.
543543
valid_status_codes: List of valid HTTP status codes (default is [200]).
544544
timeout: Optional timeout in seconds for the request.

rigging/watchers.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,6 @@ def make_stream_to_logs(
229229
level: The Loguru log level to use.
230230
max_chars: Max characters to display for content before shortening.
231231
max_lines: Max lines to display for content before shortening.
232-
**kwargs: Additional arguments to pass to the Loguru logger.
233232
234233
Returns:
235234
An awaitable callback function for use with `ChatPipeline.watch()`.

0 commit comments

Comments
 (0)