This project uses AI agent skills stored in .ai/skills/. Each skill is a directory containing a SKILL.md file with instructions for performing a specific task.
Skills follow the Agent Skills open standard. Each skill directory contains:
SKILL.md— The skill definition with YAML frontmatter (name, description, argument-hint) and detailed instructions.- Additional supporting files as needed.
Every Python function must include a docstring with usage examples.
- Examples are required: Each function needs at least one doctest-style example demonstrating basic usage.
- Optional parameters: If a function has optional parameters, include separate
examples that show usage both without and with the optional arguments. Pass
optional arguments using their keyword name (e.g.,
step=dfn.lit(3)) so readers can immediately see which parameter is being demonstrated. - Reuse input data: Use the same input data across examples wherever possible. The examples should demonstrate how different optional arguments change the output for the same input, making the effect of each option easy to understand.
- Alias functions: Functions that are simple aliases (e.g.,
list_sortaliasingarray_sort) only need a one-line description and aSee Alsoreference to the primary function. They do not need their own examples.
When adding or updating an aggregate or window function, ensure the corresponding site documentation is kept in sync:
- Aggregations:
docs/source/user-guide/common-operations/aggregations.rst— add new aggregate functions to the "Aggregate Functions" list and include usage examples if appropriate. - Window functions:
docs/source/user-guide/common-operations/windows.rst— add new window functions to the "Available Functions" list and include usage examples if appropriate.