Skip to content

Add print(result.data.head()) to documentation examples#40

Merged
CallumMcMahon merged 1 commit into
mainfrom
docs-add-result-data-head-examples
Jan 21, 2026
Merged

Add print(result.data.head()) to documentation examples#40
CallumMcMahon merged 1 commit into
mainfrom
docs-add-result-data-head-examples

Conversation

@CallumMcMahon
Copy link
Copy Markdown
Member

@CallumMcMahon CallumMcMahon commented Jan 21, 2026

I would have agents submit a big job, then have the whole result set get thrown away, because they used the output wrong

  ⎿  Error: Exit code 1                                                                                                                                                                                                                            │
│     Traceback (most recent call last):                                                                                                                                                                                                            │
│       File "<stdin>", line 77, in <module>                                                                                                                                                                                                        │
│       File "/Users/callum/.local/share/uv/python/cpython-3.13.5-macos-aarch64-none/lib/python3.13/asyncio/runners.py", line 195, in run                                                                                                           │
│         return runner.run(main)                                                                                                                                                                                                                   │
│                ~~~~~~~~~~^^^^^^                                                                                                                                                                                                                   │
│       File "/Users/callum/.local/share/uv/python/cpython-3.13.5-macos-aarch64-none/lib/python3.13/asyncio/runners.py", line 118, in run                                                                                                           │
│         return self._loop.run_until_complete(task)                                                                                                                                                                                                │
│                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^                                                                                                                                                                                                │
│       File "/Users/callum/.local/share/uv/python/cpython-3.13.5-macos-aarch64-none/lib/python3.13/asyncio/base_events.py", line 725, in run_until_complete                                                                                        │
│     … +17 lines (ctrl+o to see all)                                                                                                                                                                                                               │
│                                                                                                                                                                                                                                                   │
│⏺ The result already has the data in result.data. Let me access it directly.

Summary

  • Added print(result.data.head()) to code examples across all documentation
  • Added a "Results" section in SKILL.md explaining that result.data is a pandas DataFrame
  • Makes it clearer that operations return a result object with a DataFrame in the .data attribute

Test plan

  • Review documentation examples render correctly

🤖 Generated with Claude Code

Makes it clearer that operations return a result object with a pandas
DataFrame in the .data attribute.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@jackwildman jackwildman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this

@CallumMcMahon CallumMcMahon merged commit 689651c into main Jan 21, 2026
@CallumMcMahon CallumMcMahon deleted the docs-add-result-data-head-examples branch January 21, 2026 22:04
hnykda pushed a commit that referenced this pull request Jan 22, 2026
Makes it clearer that operations return a result object with a pandas
DataFrame in the .data attribute.

Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants