NCAS-CMS / NCAS-CMS/cf-python

Docs: include a 'How do I...?' table to direct on common tasks

Aperta
#792 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation
Lingua principale
Python
Stelle
150
Fork
23
Merge medio
1g 11h
PR unite (30g)
2

Descrizione

As part of our summit this week, we have identified that users would benefit from a page in the documentation which centers around a table which list common tasks that a user might want to do and maps them to relevant methods and their API reference pages; examples; and documentation sections.

A great example of this is an equivalent table in the xarray docs. As well as pointing to methods of direct relevance as per that table, we can include some extra columns which point to relevant sections of the Tutorial and relevant recipes, where applicable.

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.

Direzione di ricerca

Inizia esaminando la tabella equivalente “How do I...?” nella documentazione di xarray, quindi ispeziona la struttura della documentazione esistente di questo repository. Crea una pagina di documentazione che associ le attività comuni degli utenti ai metodi, ai riferimenti API, agli esempi, ai tutorial e alle ricette pertinenti, ove applicabile; il lavoro è completato quando la tabella fornisce questi collegamenti di navigazione per le attività identificate.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.