elixir-docs-review — for Claude Code elixir-docs-review, PyAgent, community, for Claude Code, ide skills, MyModule, Elixir, Review, Reference, moduledoc

v1.0.0

Über diesen Skill

Geeigneter Einsatz: Ideal for AI agents that need elixir documentation review. Lokalisierte Zusammenfassung: elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

Funktionen

Elixir Documentation Review
Issue Type Reference
------------ -----------
@moduledoc, @doc quality, anti-patterns references/doc-quality.md
@spec, @type, @typedoc coverage references/spec-coverage.md

# Core Topics

DebVisor DebVisor
[4]
[0]
Updated: 4/7/2026

Killer-Skills Review

Decision support comes first. Repository text comes second.

Reference-Only Page Review Score: 10/11

This page remains useful for teams, but Killer-Skills treats it as reference material instead of a primary organic landing page.

Original recommendation layer Concrete use-case guidance Explicit limitations and caution Quality floor passed for review
Review Score
10/11
Quality Score
51
Canonical Locale
en
Detected Body Locale
en

Geeigneter Einsatz: Ideal for AI agents that need elixir documentation review. Lokalisierte Zusammenfassung: elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

Warum diese Fähigkeit verwenden

Empfehlung: elixir-docs-review helps agents elixir documentation review. elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

Am besten geeignet für

Geeigneter Einsatz: Ideal for AI agents that need elixir documentation review.

Handlungsfähige Anwendungsfälle for elixir-docs-review

Anwendungsfall: Applying Elixir Documentation Review
Anwendungsfall: Applying Issue Type Reference
Anwendungsfall: Applying ------------ -----------

! Sicherheit & Einschränkungen

  • Einschraenkung: @moduledoc false only on internal/implementation modules
  • Einschraenkung: Function head declared when arg names need clarification
  • Einschraenkung: Valid Patterns (Do NOT Flag)

Why this page is reference-only

  • - Current locale does not satisfy the locale-governance contract.

Source Boundary

The section below is imported from the upstream repository and should be treated as secondary evidence. Use the Killer-Skills review above as the primary layer for fit, risk, and installation decisions.

After The Review

Decide The Next Action Before You Keep Reading Repository Material

Killer-Skills should not stop at opening repository instructions. It should help you decide whether to install this skill, when to cross-check against trusted collections, and when to move into workflow rollout.

Labs Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

FAQ & Installation Steps

These questions and steps mirror the structured data on this page for better search understanding.

? Frequently Asked Questions

What is elixir-docs-review?

Geeigneter Einsatz: Ideal for AI agents that need elixir documentation review. Lokalisierte Zusammenfassung: elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

How do I install elixir-docs-review?

Run the command: npx killer-skills add DebVisor/PyAgent/elixir-docs-review. It works with Cursor, Windsurf, VS Code, Claude Code, and 19+ other IDEs.

What are the use cases for elixir-docs-review?

Key use cases include: Anwendungsfall: Applying Elixir Documentation Review, Anwendungsfall: Applying Issue Type Reference, Anwendungsfall: Applying ------------ -----------.

Which IDEs are compatible with elixir-docs-review?

This skill is compatible with Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer. Use the Killer-Skills CLI for universal one-command installation.

Are there any limitations for elixir-docs-review?

Einschraenkung: @moduledoc false only on internal/implementation modules. Einschraenkung: Function head declared when arg names need clarification. Einschraenkung: Valid Patterns (Do NOT Flag).

How To Install

  1. 1. Open your terminal

    Open the terminal or command line in your project directory.

  2. 2. Run the install command

    Run: npx killer-skills add DebVisor/PyAgent/elixir-docs-review. The CLI will automatically detect your IDE or AI agent and configure the skill.

  3. 3. Start using the skill

    The skill is now active. Your AI agent can use elixir-docs-review immediately in the current project.

! Reference-Only Mode

This page remains useful for installation and reference, but Killer-Skills no longer treats it as a primary indexable landing page. Read the review above before relying on the upstream repository instructions.

Upstream Repository Material

The section below is imported from the upstream repository and should be treated as secondary evidence. Use the Killer-Skills review above as the primary layer for fit, risk, and installation decisions.

Upstream Source

elixir-docs-review

Install elixir-docs-review, an AI agent skill for AI agent workflows and automation. Review the use cases, limitations, and setup path before rollout.

SKILL.md
Readonly
Upstream Repository Material
The section below is imported from the upstream repository and should be treated as secondary evidence. Use the Killer-Skills review above as the primary layer for fit, risk, and installation decisions.
Supporting Evidence

Elixir Documentation Review

Quick Reference

Issue TypeReference
@moduledoc, @doc quality, anti-patternsreferences/doc-quality.md
@spec, @type, @typedoc coveragereferences/spec-coverage.md

Review Checklist

Module Documentation

  • All public modules have @moduledoc
  • First-line summary is concise (one line, used by tools as summary)
  • @moduledoc includes ## Examples where appropriate
  • @moduledoc false only on internal/implementation modules

Function Documentation

  • All public functions have @doc
  • All public functions have @spec
  • @doc describes return values clearly
  • Multi-clause functions documented before first clause
  • Function head declared when arg names need clarification

Doctests

  • Doctests present for pure, deterministic functions
  • No doctests for side-effectful operations (DB, HTTP, etc.)
  • Doctests actually run (module included in test file)

Cross-References

  • Module references use backtick auto-linking (MyModule)
  • Function refs use proper arity format (function/2)
  • Type refs use t: prefix (t:typename/0)
  • No plain-text references where auto-links are possible

Metadata

  • @since annotations on new public API additions
  • @deprecated with migration guidance where appropriate

Valid Patterns (Do NOT Flag)

  • @doc false on callback implementations - Documented at behaviour level
  • @doc false on protocol implementations - Protocol docs cover the intent
  • Missing @spec on private functions - @spec optional for internals
  • Short @moduledoc without ## Examples on simple utility modules - Not every module needs examples
  • Using @impl true without separate @doc - Inherits documentation from behaviour

Context-Sensitive Rules

IssueFlag ONLY IF
Missing @moduledocModule is public AND not a protocol impl
Missing @specFunction is public AND exported
Missing doctestsFunction is pure AND deterministic
Generic @docDoc restates function name without adding value

When to Load References

  • Reviewing @moduledoc or @doc quality, seeing anti-patterns -> doc-quality.md
  • Reviewing @spec, @type, or @typedoc coverage -> spec-coverage.md

Before Submitting Findings

Load and follow review-verification-protocol before reporting any issue.

Verwandte Fähigkeiten

Looking for an alternative to elixir-docs-review or another community skill for your workflow? Explore these related open-source skills.

Alle anzeigen

openclaw-release-maintainer

Logo of openclaw
openclaw

Your own personal AI assistant. Any OS. Any Platform. The lobster way. 🦞

333.8k
0
Künstliche Intelligenz

widget-generator

Logo of f
f

Erzeugen Sie anpassbare Widget-Plugins für das Prompts.Chat-Feed-System

149.6k
0
Künstliche Intelligenz

flags

Logo of vercel
vercel

Das React-Framework

138.4k
0
Browser

pr-review

Logo of pytorch
pytorch

Tensor und dynamische neuronale Netze in Python mit starker GPU-Beschleunigung

98.6k
0
Entwickler