Python API page in the docs

Chiusa Adatta ai principianti
#13 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Leggi src/shrinkvec/lab.py e codecs/__init__.py per capire come vengono usati run_lab, make_codec e run_pg. Aggiungi docs/python.md con un esempio eseguibile che utilizzi un piccolo dataset casuale, poi fai in modo che l’esempio venga eseguito come doctest o test. Il lavoro è completato quando l’esempio viene eseguito correttamente nell’ambito di un test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue

run_lab, make_codec and run_pg are usable from a notebook, but only the CLI is documented.

Where to start: src/shrinkvec/lab.py and codecs/__init__.py. A docs/python.md with a runnable example on a small random dataset.

Done when: the example runs as a test (a doctest or a test that executes the snippet).

Lingua principale
Python
Stelle
0
Fork
0
Merge medio
1h 35m
PR unite (30g)
5

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ahmad-codex/shrinkvec

Tutte le issue di ahmad-codex/shrinkvec

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.