Document all supported mapping projections

Aperta Adatta ai principianti
#156 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
77/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Trova gli esempi della documentazione per proj=<projection name> e i parametri della docstring di mapset usati per generare il riferimento API. Inizia elencando i casi di proiezione già mostrati negli esempi, poi collega ciascuno di essi da una nuova tabella e aggiungi le opzioni supportate ai parametri di mapset. Il lavoro è terminato quando entrambe le posizioni della documentazione elencano le possibilità e la tabella include note pertinenti.

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

Descrizione

docs enhancement

The documentation alludes to the supported projections with the inclusion of examples covering all of the cases for proj=<projection name>, but without wading through these all one can't tell what projections are allowed because there is not explicit list or similar.

We should therefore, for clarity:

  • add a table to note all of the possibilities, link to examples using each one, and provide any relevant notes for each case;
  • list the possibilities in the parameters section of the docstrings as parsed to the API reference for mapset which congures a non-default projection via the keyword proj
Lingua principale
Python
Stelle
21
Fork
11
Merge medio
2g 21h
PR unite (30g)
7

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 NCAS-CMS/cf-plot

Tutte le issue di NCAS-CMS/cf-plot

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.