Ana içeriğe geç

API Referans Genel Bakış

Weeb CLI API referans dokümantasyonuna hoş geldiniz. Bu bölüm, kod tabanındaki tüm modüller, sınıflar ve fonksiyonlar için detaylı dokümantasyon sağlar.

Organizasyon

API dokümantasyonu pakete göre düzenlenmiştir:

Temel Modüller

Temel işlevsellik sağlayan önemli modüller:

  • Config: Yapılandırma yönetim sistemi
  • I18n: Uluslararasılaştırma ve yerelleştirme
  • Exceptions: Özel istisna hiyerarşisi

Sağlayıcılar

Anime kaynak sağlayıcı uygulamaları:

Servisler

İş mantığı ve temel işlevsellik:

Komutlar

CLI komut uygulamaları:

UI Bileşenleri

Terminal kullanıcı arayüzü öğeleri:

  • Menü: Etkileşimli menü sistemi
  • İstem: Kullanıcı girişi istemleri
  • Başlık: Uygulama başlığı gösterimi

Hızlı Bağlantılar

Yaygın Görevler

Tip İpuçları

Tüm modüller daha iyi IDE desteği ve kod netliği için kapsamlı tip ipuçları kullanır:

from typing import List, Optional, Dict

def search(query: str) -> List[AnimeResult]:
    """Tam tip bilgisi ile arama."""
    pass

Docstring Stili

Her yerde Google stili docstring'ler kullanıyoruz:

def function(param: str) -> bool:
    """Kısa açıklama.

    Args:
        param: Parametre açıklaması.

    Returns:
        Dönüş değeri açıklaması.

    Example:
        >>> function("test")
        True
    """
    pass

API dokümantasyonunda gezinmek için kenar çubuğunu kullanın. Her sayfa şunları içerir:

  • Modül genel bakışı
  • Sınıf ve fonksiyon imzaları
  • Detaylı açıklamalar
  • Kullanım örnekleri
  • Tip bilgisi

Katkıda Bulunma

Dokümantasyonda bir sorun mu buldunuz? Lütfen bir sorun açın veya bir pull request gönderin.