apache / apache/datafusion-python

Improve online documentation page for DataFrame

未關閉
#1,397 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
enhancement good first issue
主要語言
Python
星號
604
分支
174
平均合併
2 天 22 小時
30 天內合併 PR
5

描述

**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.

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

首先檢視文件網站上的 DataFrame 頁面,包括其中關於常見操作、Arrow C 介面和渲染的章節。考慮 pull request 1381 中執行指標相關資料的歸屬位置,然後為新使用者定義更清楚的流程。完成的標準是頁面具有組織得更好的結構,並為新資料提供明確的位置。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
5/5
預估耗時
一週以上
活躍度
冷清
描述清晰度
需要釐清
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。