AnswerDotAI/shell_sage

Add API Documentation

Aberta

#36 aberto em 15 de fev. de 2025

Ver no GitHubGuia do colaborador
 (3 comentários) (1 reação) (0 responsável)Jupyter Notebook (44 forks)auto 404
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (406 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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

Guia do colaborador

Direção de pesquisa
Revise a base de código existente para entender a API pública, adicione docstrings às funções e crie uma página de documentação abrangente.
Pilha de tecnologia
python
Domain
cli
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70