Improve online documentation page for DataFrame

オープン
#1,397 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
静か
技術スタック
python
領域
documentation

調査の方向性

まず、ドキュメントサイトのDataFrameページを確認し、一般的な操作、Arrow Cインターフェース、レンダリングに関するセクションも確認します。pull request 1381の実行メトリクスに関する資料をどこに配置するべきかを検討し、そのうえで新しいユーザー向けの、より明確な流れを定義します。ページの構成がより整理され、新しい資料の明確な配置場所が決まれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
605
フォーク
176
平均マージ
1日 23時間
マージ済み PR（30日）
8

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

apache/datafusion-python のほかの issue

apache/datafusion-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。