linkmerce-docstring-dag-style

Standardize LinkMerce docstrings and Airflow DAG narratives to match repository layer boundaries.

3|Updated Jul 22, 2025
One-click install
npx skills add https://github.com/minyeamer/linkmerce --skill linkmerce-docstring-dag-style
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: linkmerce-docstring-dag-style
Source: https://github.com/minyeamer/linkmerce/tree/main/.codex/skills/linkmerce-docstring-dag-style
Command: npx skills add https://github.com/minyeamer/linkmerce --skill linkmerce-docstring-dag-style

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents inconsistent, confusing, or outdated documentation across LinkMerce’s Extractor/Transformer/API/DAG layers by enforcing the repository’s approved narrative and section structure.

Core Features & Use Cases

  • Docstring consistency for LinkMerce code: Keeps src/linkmerce/core/**/*.py and src/linkmerce/api/**/*.py docstrings aligned with approved wording and clear layer boundaries.
  • DAG doc_md readability: Produces or updates Airflow DAG doc_md text in airflow/dags/**/*.py so orchestration, strategy, and load/extract/transform responsibilities are described correctly.
  • Safe, implementation-aligned changes: Ensures table names, parser names, return shapes, and load strategy remain consistent with the actual code, updating tests or nearby docs when behavior changes.

Quick Start

Use the linkmerce-docstring-dag-style skill to update the doc_md for your Airflow DAG so it follows the repository’s layer-boundary wording and section order.

Frequently Asked Questions about linkmerce-docstring-dag-style

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

FAQPage Schema
How do I standardize Airflow DAG doc_md text to match repository layer boundaries?

To standardize Airflow DAG doc_md text, you apply approved layer-boundary wording and section order to correctly describe orchestration, strategy, and load/extract/transform responsibilities. This ensures DAG narratives align with approved repository phrasing.

What is the best way to keep Python docstrings consistent across Extractor and Transformer layers?

Keeping Python docstrings consistent across layers requires aligning docstrings in core and API modules with approved wording and clear layer boundaries. This prevents inconsistent documentation by enforcing the repository's approved narrative and section structure.

Do I need to read specific instruction files before updating LinkMerce docstrings?

Yes, you need to read the .github/instructions/lm.instructions.md file before updating LinkMerce docstrings. This instruction file serves as the source of truth for approved layer boundaries and phrasing when standardizing documentation.

Can I update docstrings without breaking implementation-specific names and return shapes?

Yes, you can update docstrings while preserving implementation-specific names, parser names, return shapes, and load strategy. The standardization process ensures table names and return shapes remain consistent with the actual code.

When should I update tests or nearby docs when modifying Airflow DAG documentation?

You should update tests or nearby docs when modifying Airflow DAG documentation if the behavior changes. This ensures that documentation updates remain safe and implementation-aligned when DAG doc_md text is adjusted.

Why does inconsistent documentation cause problems across ETL layer boundaries?

Inconsistent documentation causes problems across ETL layer boundaries by creating confusing or outdated documentation that obscures Extractor/Transformer/API/DAG responsibilities. Enforcing approved narrative and section structure prevents this inconsistency.