Skip to content

Commit 06e50ef

Browse files
timsaucerclaude
andcommitted
Distinguish user guide from agent reference in module docstring
The docstring pointed readers at SKILL.md as a "comprehensive guide," but SKILL.md is written in a dense, skill-oriented format for agents — humans are better served by the online user guide. Put the online docs first as the primary reference and label the SKILL.md link as the agent reference. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 07d38c7 commit 06e50ef

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

python/datafusion/__init__.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,11 @@
4848
>>> result.to_pydict()
4949
{'grand_total': [16]}
5050
51-
For a comprehensive guide to the DataFrame API -- including a SQL-to-DataFrame
52-
reference table, expression building, idiomatic patterns, and common pitfalls --
53-
see ``SKILL.md`` at the root of the datafusion-python repository:
54-
https://github.com/apache/datafusion-python/blob/main/SKILL.md
51+
User guide and full documentation: https://datafusion.apache.org/python
5552
56-
Full documentation: https://datafusion.apache.org/python
53+
AI agent reference (SQL-to-DataFrame mappings, expression-building patterns,
54+
common pitfalls), written in a dense, skill-oriented format:
55+
https://github.com/apache/datafusion-python/blob/main/SKILL.md
5756
"""
5857

5958
from __future__ import annotations

0 commit comments

Comments
 (0)