AnswerDotAI/shell_sage

Add API Documentation

Offen

#36 geöffnet am 15.02.2025

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Jupyter Notebook (44 Forks)auto 404
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (406 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene Codebasis, um die öffentliche API zu verstehen, fügen Sie Docstrings zu Funktionen hinzu und erstellen Sie eine umfassende Dokumentationsseite.
Tech Stack
python
Domain
cli
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70