Doc improvements

オープン

#1,463 2026年3月29日に作成コメント 1 件リアクション 0 件担当者 0 名 GitHub で見る

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

評価

難易度: 3/5
見積もり時間: 1〜2日
初心者へのやさしさ: 72/100

issue の種類: ドキュメント
明瞭さ: おおむね明確
活発さ: 静か
技術スタック: python
領域: documentation

調査の方向性

まず python/datafusion/functions.py を読み、alias docstring と他の function docstrings を比較します。引数の説明がない関数を特定し、既存の例と一貫するようにドキュメントを追加します。このファイル内のすべての function docstrings に引数のドキュメントが含まれれば、作業は完了です。

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

説明

enhancement

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

I'm trying to use documentation to understand the arguments to functions in functions.py.

Describe the solution you'd like

I'd love if all the function docstrings had documentation for the arguments to the function. For example, alias has descriptions of its arguments.

Describe alternatives you've considered

None, really, just recording it as a unit of work that would improve the project.

Additional context

This is a follow-on issue to @ntjohnson1 excellent work in https://github.com/apache/datafusion-python/pull/1435 where he added tons of helpful examples. I was browsing the code in the PR and realized quite a few functions were missing argument documentation.

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

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

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

はじめの一歩

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

apache/datafusion-python のほかの issue

Rewrite the "Encode metadata, not a handle to a live object" section オープン

documentation

難易度 2/5 1〜3時間初心者へのやさしさ 72/100

apache/datafusion-python#1726 · 2026年9月11日に作成
Missing docstring examples in the `unparser` module オープン

難易度 2/5 半日初心者へのやさしさ 88/100

apache/datafusion-python#1691 · 2026年8月16日に作成
Build fails against DataFusion 54.1.0 due to new `schema` field on `RecursiveQuery` オープン

bug

難易度 2/5 1〜3時間初心者へのやさしさ 78/100

apache/datafusion-python#1644 · 2026年7月24日に作成
Allow extension libraries to contribute object stores over FFI オープン

enhancement

難易度 5/5 1週間以上初心者へのやさしさ 30/100

apache/datafusion-python#1737 · 2026年9月15日に作成
CsvReadOptions.null_regex has no effect: matching values are read as literal strings, and fail the read in a numeric column オープン

難易度 3/5 1〜2日初心者へのやさしさ 76/100

apache/datafusion-python#1735 · コメント 1 件 · 2026年9月12日に作成

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

似ている issue

create_predictable_zip member order differs on Windows for directory input オープン

bug

難易度 2/5 1〜3時間初心者へのやさしさ 90/100

learningequality/ricecooker#747 · 2026年9月23日に作成
[Anon] Mechanicum: skitarii as mechanicum allies rule オープン

難易度 2/5 1〜3時間初心者へのやさしさ 68/100

BSData/horus-heresy-3rd-edition#3171 · 2026年9月23日に作成
CHANGELOG.md entries are too long to maintain, and their length is what makes every PR conflict expensive オープン

enhancement

難易度 2/5 1〜3時間初心者へのやさしさ 72/100

lanl/PyBNF#809 · 2026年9月23日に作成
[Bug]: PrevNextNodePostprocessor loses retrieved scores when neighbor windows overlap オープン

難易度 2/5 1〜3時間初心者へのやさしさ 76/100

run-llama/llama_index#23199 · 2026年9月23日に作成
Cannot export point cloud without radius attribute オープン

難易度 2/5 1〜3時間初心者へのやさしさ 84/100

KhronosGroup/glTF-Blender-IO#2769 · 2026年9月23日に作成

Python の issue をもっと見る