Improve docstring and typehint of dims/axis Simplex

Aperta Adatta ai principianti
#280 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
62/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia dall'operatore prossimale di Simplex e dai suoi parametri dims/axis. Vanno modificati la docstring e il type hint di questi argomenti. Leggi la docstring della classe Simplex per vedere cosa dice attualmente su dims e axis, poi verifica se il type hint della firma corrisponde al vincolo di 2 dimensioni e axis 0 o 1. È completato quando la docstring indica che dims deve essere 2D e che axis può essere solo 0 o 1, e il type hint lo riflette.

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

Descrizione

documentation

The docstring of Simplex currently does not clarify the fact that dims can only be 2dimensional and therefore axis can only be 0 or 1 (currently set as -1 = 1).

Clarify this.

Lingua principale
Python
Stelle
85
Fork
22
Merge medio
2h 11m
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 PyLops/pyproximal

Tutte le issue di PyLops/pyproximal

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.