Improve online documentation page for DataFrame

Abierto
#1,397 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza revisando la página de DataFrame en el sitio de documentación, incluidas sus secciones sobre operaciones comunes, la interfaz C de Arrow y el renderizado. Considera dónde encaja el material sobre métricas de ejecución de pull request 1381 y, después, define un flujo más claro para los nuevos usuarios. Se considera terminado cuando la página tiene una estructura mejor organizada y un lugar claro para el nuevo material.

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

Descripción

enhancement good first issue

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

It feels to me like the documentation page for DataFrame is a bit all over the place about what kinds of information it contains. It jumps around from common operations to using the Arrow C interface to rendering. I think this page could greatly benefit from some cleanup.

Describe the solution you'd like

Take a fresh look at the documentation site and come up with a better organization for the types of materials we are sharing. Make a better flow for new users approaching the project.

Describe alternatives you've considered

Status quo.

Additional context

We are probably going to add a new section describing how to access and use execution metrics https://github.com/apache/datafusion-python/pull/1381 , and it is not clear where this should be on the existing page. Hence, the need for a bit of overhaul.

Lenguaje dominante
Python
Estrellas
605
Forks
176
Merge medio
1 d 23 h
PR fusionados (30 d)
8

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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 apache/datafusion-python

Todos los issues de apache/datafusion-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.