documentation

Repair Elixir moduledoc, function docs, and specs for target files.

11|Updated Dec 28, 2024
One-click install
npx skills add https://github.com/wadvanced/aurora_uix --skill documentation-wadvanced
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/wadvanced/aurora_uix/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/wadvanced/aurora_uix --skill documentation-wadvanced

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps prevent broken or incomplete Elixir documentation by guiding you to add missing moduledocs and function docs, along with required specs, without changing any logic.

Core Features & Use Cases

  • Ensures consistent module documentation: Adds or repairs @moduledoc, @doc, @spec, and @shortdoc where required.
  • Runs and iterates on doc warnings: Uses mix consistency to find docs/doctor issues and then fixes only those tied to the provided target file.
  • Applies strict safety rules: Never alters code logic, never changes function ordering or module attributes beyond documentation needs, and avoids modifying definitions or internal structures.

Quick Start

Run the documentation skill on the single Elixir module file path you want to document so it can address the mix consistency documentation warnings for that file.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I fix Elixir moduledoc and typespec warnings reported by mix consistency?

To fix Elixir moduledoc and typespec warnings reported by mix consistency, you can add or repair missing `@moduledoc`, `@doc`, `@spec`, and `@shortdoc` attributes in your target file without altering any existing code logic.

What is the best way to add missing function docs and specs to an Elixir module?

The best way to add missing function docs and specs to an Elixir module is to iterate on `mix consistency` outputs and apply strict documentation-stage edits, ensuring you add `@doc` and `@spec` attributes while preserving the original logic.

How does mix consistency detect documentation and doctor warnings in Elixir?

Mix consistency detects documentation and doctor warnings in Elixir by running iterative checks against your codebase, flagging specific `*.ex` or `*.exs` files that lack required `@moduledoc`, `@doc`, or `@spec` attributes.

Can I repair Elixir documentation warnings without changing code logic?

Yes, you can repair Elixir documentation warnings without changing code logic by applying strict non-invasive rules that only modify documentation attributes and never alter function definitions, ordering, or unrelated internal structures.

Does fixing typespec and moduledoc warnings require modifying unrelated code in Elixir?

No, fixing typespec and moduledoc warnings does not require modifying unrelated code in Elixir. The process enforces strict non-invasive rules, ensuring only doc-stage edits are tied to the specific target file.