Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

docstring improvements

Abierto
  • ¿Algo no está bien?
#322 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Search for the docstrings of cf_xarray.bounds_to_vertices, vertices_to_bounds, shapely_to_cf, cf_to_shapely, and set_options, then compare them with the listed numpydoc warnings. Update the summaries, parameter and return documentation, See Also sections, and examples as applicable, and confirm that the reported validation warnings are resolved.

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

Descripción

documentation good first issue help wanted

Would be good to clean up these warnings

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.bounds_to_vertices':
  SS06: Summary should fit in a single line
  PR03: Wrong parameters order. Actual: ('bounds', 'bounds_dim', 'core_dims', 'order'). Documented: ('bounds', 'bounds_dim', 'order', 'core_dims')
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.vertices_to_bounds':
  SS06: Summary should fit in a single line
  RT03: Return value has no description
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.shapely_to_cf':
  GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.cf_to_shapely':
  GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
  SA01: See Also section not found
  EX01: No examples section found

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.set_options':
  GL01: Docstring text (summary) should start in the line immediately after the opening quotes (not in the same line, or leaving a blank line in between)
  ES01: No extended summary found
  PR01: Parameters {'**kwargs'} not documented
  PR02: Unknown parameters {'custom_criteria', 'warn_on_missing_variables'}
  SA01: See Also section not found
Lenguaje dominante
Python
Estrellas
181
Forks
49
Merge medio
43 min
PR fusionados (30 d)
1

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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 xarray-contrib/cf-xarray

Todos los issues de xarray-contrib/cf-xarray

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.