skills.rest
apache
apacheOFFICIAL
Explore all skills by this author →
WebsiteGitHub

audit-skill-md

Audits the datafusion-python skill documentation against the current public Python API.

599|167|Updated Jul 20, 2022
Search Tags:#audit#Documentation#datafusion#upstream sync#python API#Code review#version notes
One-click install
npx skills add https://github.com/apache/datafusion-python --skill audit-skill-md
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: audit-skill-md
Source: https://github.com/apache/datafusion-python/tree/main/.ai/skills/audit-skill-md
Command: npx skills add https://github.com/apache/datafusion-python --skill audit-skill-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After upstream DataFusion syncs or refactors, the user-facing skill documentation at skills/datafusion_python/SKILL.md can drift from the actual Python API, leaving AI coding assistants with stale function names, missing new APIs, or outdated examples. This Skill systematically audits that documentation against the real public surface so it always matches what the project ships.

Core Features & Use Cases

  • Gap Detection: Finds new public APIs in SessionContext, DataFrame, Expr, and functions modules that are not yet documented, with proposed insertion points.
  • Staleness Checks: Verifies every function name, method call, and import mentioned in the skill still exists in the current codebase, proposing renames or removals.
  • Style and Version Audits: Flags examples that drifted from idiomatic Pythonic style (unnecessary lit()/col() wrapping) and identifies missing "requires datafusion-python NN or newer" annotations.
  • Use Case: After merging an upstream sync PR, run the audit with scope "all" to produce a grouped report of documentation edits before the release ships.

Quick Start

Ask the assistant to audit the datafusion-python skill documentation against the current API for scope all and report new APIs, stale mentions, and missing version notes.

Frequently Asked Questions about audit-skill-md

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit datafusion-python skill documentation after an upstream sync?▼

Run this audit skill after the check-upstream step of an upstream sync. It compares skills/datafusion_python/SKILL.md against the public symbols in python/datafusion modules and reports new APIs, stale mentions, and drifted examples grouped by scope.

What scopes can I audit in the datafusion-python skill?▼

Supported scopes are session-context, dataframe, expr, functions, spark-functions, patterns, pitfalls, version-notes, and all. Passing no scope or "all" audits every documented surface of the Python API.

How does the audit detect API changes since the last review?▼

It diffs git history for python/datafusion modules against a previous commit SHA if provided, or falls back to commits touching the datafusion pin in Cargo.toml. Signature changes are found by grepping diff output for changed def lines.

Does the audit flag every undocumented public function?▼

No. It deliberately skips niche, experimental, or internal FFI plumbing symbols, since the skill is curated for daily-use patterns rather than exhaustive API reference. It only flags symbols that fit existing categories or change documented patterns.

When should version notes be added to skill documentation?▼

Add a note when an API was added in a specific release, when a breaking change altered behavior, or when a documented pitfall was fixed upstream. The format is an italicized line such as "Requires datafusion-python 53 or newer."

Related Skills

Explore More Software Engineering Skills→
apacheapache
595

check-upstream

Audits python-api coverage of upstream DataFusion Rust bindings and reports gaps.

Official
Intermediate
getkyogetkyo
807

readme-verify

Validate READMEs through a five-gate verification workflow.

Official
Advanced
apacheapache
595

make-pythonic

Audits and refactors Apache DataFusion Python API to accept native types for literal arguments.

Official
Advanced
HomericIntelligenceHomericIntelligence
18

generate-api-docs

Generates API reference documentation from Python docstrings using pdoc or Sphinx.

Official
Intermediate