AnswerDotAI/shell_sage

Add API Documentation

Ouverte

#36 ouverte le 15 févr. 2025

Voir sur GitHubGuide contributeur
 (3 commentaires) (1 réaction) (0 personne assignée)Jupyter Notebook (44 forks)auto 404
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (406 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez la base de code existante pour comprendre l'API publique, ajoutez des docstrings aux fonctions et créez une page de documentation complète.
Stack technique
python
Domaine
cli
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70