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

v1.0.0
GitHub

Sobre este Skill

Cenario recomendado: Ideal for AI agents that need elixir documentation review. Resumo localizado: elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

Recursos

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

# Tópicos principais

for Claude Code MyModule Elixir Review Reference moduledoc
DebVisor DebVisor
[4]
[0]
Atualizado: 4/7/2026

Skill Overview

Start with fit, limitations, and setup before diving into the repository.

Cenario recomendado: Ideal for AI agents that need elixir documentation review. Resumo localizado: elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

Por que usar essa habilidade

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

Melhor para

Cenario recomendado: Ideal for AI agents that need elixir documentation review.

↓ Casos de Uso Práticos for elixir-docs-review

Caso de uso: Applying Elixir Documentation Review
Caso de uso: Applying Issue Type Reference
Caso de uso: Applying ------------ -----------

! Segurança e Limitações

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

About The Source

The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.

Demo Labs

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 e etapas de instalação

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

? Perguntas frequentes

O que é elixir-docs-review?

Cenario recomendado: Ideal for AI agents that need elixir documentation review. Resumo localizado: elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

Como instalar elixir-docs-review?

Execute o comando: npx killer-skills add DebVisor/PyAgent/elixir-docs-review. Ele funciona com Cursor, Windsurf, VS Code, Claude Code e mais de 19 outros IDEs.

Quais são os casos de uso de elixir-docs-review?

Os principais casos de uso incluem: Caso de uso: Applying Elixir Documentation Review, Caso de uso: Applying Issue Type Reference, Caso de uso: Applying ------------ -----------.

Quais IDEs são compatíveis com elixir-docs-review?

Esta skill é compatível com 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 a CLI do Killer-Skills para uma instalação unificada.

elixir-docs-review tem limitações?

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

↓ Como instalar este skill

  1. 1. Abra o terminal

    Abra o terminal ou linha de comando no diretório do projeto.

  2. 2. Execute o comando de instalação

    Execute: npx killer-skills add DebVisor/PyAgent/elixir-docs-review. A CLI detectará sua IDE ou agente automaticamente e configurará a skill.

  3. 3. Comece a usar o skill

    O skill já está ativo. Seu agente de IA pode usar elixir-docs-review imediatamente no projeto atual.

! Source Notes

This page is still useful for installation and source reference. Before using it, compare the fit, limitations, and upstream repository notes above.

Upstream Repository Material

The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.

Upstream Source

elixir-docs-review

Install elixir-docs-review, an AI agent skill for AI agent workflows and automation. Explore features, use cases, limitations, and setup guidance.

SKILL.md
Readonly
Upstream Repository Material
The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.
Upstream Source

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.

Habilidades Relacionadas

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

Ver tudo

openclaw-release-maintainer

Logo of openclaw
openclaw

Resumo localizado: 🦞 # OpenClaw Release Maintainer Use this skill for release and publish-time workflow. It covers ai, assistant, crustacean workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

★ 333.8k
⑂ 0
Inteligência Artificial

widget-generator

Logo of f
f

Resumo localizado: Generate customizable widget plugins for the prompts.chat feed system # Widget Generator Skill This skill guides creation of widget plugins for prompts.chat . It covers ai, artificial-intelligence, awesome-list workflows. This AI agent skill supports Claude Code, Cursor, and

★ 149.6k
⑂ 0
Inteligência Artificial

flags

Logo of vercel
vercel

Resumo localizado: The React Framework # Feature Flags Use this skill when adding or changing framework feature flags in Next.js internals. It covers blog, browser, compiler workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

★ 138.4k
⑂ 0
Navegador

pr-review

Logo of pytorch
pytorch

Resumo localizado: Usage Modes No Argument If the user invokes /pr-review with no arguments, do not perform a review . It covers autograd, deep-learning, gpu workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

★ 98.6k
⑂ 0
Desenvolvedor