Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Provide proper SDK Documentation

Aperta
#790 3 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia confrontando le descrizioni dei campi generate dal Python SDK con l’esempio del Go SDK collegato nell’issue. Individua il punto di ingresso della generazione della documentazione e l’ambito dei modelli API interessati; il lavoro è completato quando gli utenti Python ricevono descrizioni significative delle proprietà anziché testo segnaposto ripetuto.

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

Descrizione

SDK

I see that the go SDK has great API documentation (example).

The python SDK only provides rather useless text parts:

The value to assign to XXX of this YYY.

It would be great if also the python folks can benefit from good documentation.

Thanks!

Lingua principale
Python
Stelle
474
Fork
321
Merge medio
23m
PR unite (30g)
4

Guida per i contributori

Apri la guida per i contributori

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 oracle/oci-python-sdk

Tutte le issue di oracle/oci-python-sdk

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.