AnswerDotAI/shell_sage

Add API Documentation

Aperta

#36 aperta il 15 feb 2025

Vedi su GitHubGuida contributor
 (3 commenti) (1 reazione) (0 assegnatari)Jupyter Notebook (44 fork)auto 404
documentationgood first issuehelp wanted

Metriche repository

Star
 (406 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Rivedi il codice esistente per comprendere l'API pubblica, quindi aggiungi docstring alle funzioni e crea una pagina di documentazione completa.
Tech stack
python
Dominio
cli
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70