AnswerDotAI/shell_sage

Add API Documentation

オープン

#36 opened on 2025/02/15

 (3 件のコメント) (1 件のリアクション) (0 人の担当者)Jupyter Notebook (44 件のフォーク)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (406 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Create comprehensive API documentation covering:

  • Core functions and classes
  • Parameters and return types
  • Usage examples
  • Error handling

Example additions:

## API Reference
### get_sage(provider, model, base_url=None, api_key=None, mode='default')
Creates a new ShellSage instance with specified configuration.

Parameters:
- provider: str - The AI provider to use ('anthropic' or 'openai')
- model: str - Model name to use

Estimated time: 3-4 hours

コントリビューターガイド