Improve docstring and typehint of dims/axis Simplex

Abierto Apto para principiantes
#280 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
62/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

Empieza por el operador proximal de Simplex y sus parámetros dims/axis. Lo que hay que cambiar son el docstring y la anotación de tipo de estos argumentos. Lee el docstring de la clase Simplex para ver qué dice actualmente sobre dims y axis, y luego comprueba si la anotación de tipo de la firma coincide con la restricción de 2 dimensiones y axis 0 o 1. Está terminado cuando el docstring indica que dims debe ser 2D y que axis solo puede ser 0 o 1, y la anotación de tipo lo refleja.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
85
Forks
22
Merge medio
2 h 11 min
PR fusionados (30 d)
7

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PyLops/pyproximal

Todos los issues de PyLops/pyproximal

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.