MerginMaps / MerginMaps/python-api-client
Add example to the command lines
Aperta
Nessuno ha ancora preso questa issue.
enhancement
good first issue
- Lingua principale
- Python
- Stelle
- 23
- Fork
- 12
- Merge medio
- 2g 13h
- PR unite (30g)
- 7
Descrizione
I am struggling to use most of the command lines reading the help files. Like most terminal commands, I prefer to look at examples!
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia esaminando i file della guida della riga di comando e individuando quali comandi non hanno esempi di utilizzo. Aggiungi esempi pratici per i comandi inclusi nella richiesta, quindi verifica che l'output della guida mostri chiaramente come utilizzare ogni comando.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- cli, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 30/100