Skip to content

docs: framework-modules リファレンスに公開APIの未記載エントリを追加#106

Merged
hideyukiMORI merged 1 commit into
mainfrom
docs/doc-audit-3
May 19, 2026
Merged

docs: framework-modules リファレンスに公開APIの未記載エントリを追加#106
hideyukiMORI merged 1 commit into
mainfrom
docs/doc-audit-3

Conversation

@hideyukiMORI
Copy link
Copy Markdown
Owner

Summary

__all__ に含まれているが framework-modules.md に記載されていなかった公開 API を EN/JA 両版に追加。

追加した API(6種類)

モジュール クラス/型 説明
nene2.http PaginationQuery PaginationQueryParser.parse() の戻り値型
nene2.http HealthCheckProtocol / HealthStatus ヘルスチェックの契約と結果型
nene2.database DatabaseHealthCheck HealthCheckProtocol 実装・DB 接続確認
nene2.database DatabaseConnectionException DB 接続不能時の例外
nene2.mcp McpHttpResponse HttpxMcpClient の戻り値型
nene2.mcp McpHttpClientProtocol カスタム MCP HTTP クライアントの構造的契約

Test plan

  • 全内部リンクをスクリプトで検証 — 問題なし
  • ドキュメントのみの変更

🤖 Generated with Claude Code

__all__ に含まれているがドキュメント化されていなかった公開 API を EN/JA 両版に追加:

nene2.http:
- PaginationQuery — PaginationQueryParser.parse() の戻り値型
- HealthCheckProtocol / HealthStatus — ヘルスチェック契約と結果型

nene2.database:
- DatabaseHealthCheck — HealthCheckProtocol 実装、DB接続確認
- DatabaseConnectionException — DB接続不能時の例外

nene2.mcp:
- McpHttpResponse — HttpxMcpClient の戻り値型(status_code / body / is_successful())
- McpHttpClientProtocol — カスタム MCP HTTP クライアントの構造的契約

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant