review-groovydoc

Validate GroovyDoc blocks for input/output alignment and tag ordering.

521|81|Updated Feb 22, 2019
One-click install
npx skills add https://github.com/bactopia/bactopia --skill review-groovydoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-groovydoc
Source: https://github.com/bactopia/bactopia/tree/main/.claude/skills/review-groovydoc
Command: npx skills add https://github.com/bactopia/bactopia --skill review-groovydoc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires conda, bactopia-lint, and includes scripts (resource) components.

What problem does it solve?

This Skill helps ensure GroovyDoc accuracy across bactopia modules and subworkflows by auditing documentation against standards and surfacing drift.

Core Features & Use Cases

  • Validates GroovyDoc blocks for alignment of @output/@input fields, correct @modules/@subworkflows listings, and presence of valid @citation keys.
  • Checks tag order, formatting, and presence of required sections to support code reviews, lint automation, and ongoing documentation audits.
  • Use Case: Run a GroovyDoc audit across all modules and subworkflows to identify mismatches and generate a patch set for review.

Quick Start

Run a GroovyDoc audit across the codebase to report findings using bactopia-lint.

Frequently Asked Questions about review-groovydoc

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

FAQPage Schema
How do I validate GroovyDoc tags across Nextflow modules and subworkflows?

You can validate GroovyDoc accuracy by running an audit that checks @output/@input alignment, @modules/@subworkflows completeness, valid @citation keys, and proper tag ordering across bactopia modules and subworkflows to surface documentation drift.

Why does my GroovyDoc documentation drift from module code during CI?

GroovyDoc documentation drifts from module code during CI when @output/@input fields, @modules/@subworkflows listings, or @citation keys are updated in code but not reflected in the docs. An audit enforces required sections, tag order, and formatting to identify these mismatches.

How do I fix GroovyDoc inconsistencies in bactopia modules?

To fix GroovyDoc inconsistencies in bactopia modules, execute a GroovyDoc audit to identify mismatches in @output/@input alignment, @modules/@subworkflows listings, and @citation keys, then apply the generated patch set for review to correct the documentation drift.

Does bactopia-lint support GroovyDoc validation for code reviews?

Yes, bactopia-lint supports GroovyDoc validation for code reviews by checking tag order, formatting, and presence of required sections across modules and subworkflows. It surfaces documentation drift and enforces rules like @output/@input alignment and valid @citation keys.

What is the best way to lint GroovyDoc blocks for required sections and formatting?

The best way to lint GroovyDoc blocks for required sections and formatting is to run an automated audit that checks tag ordering, @output/@input alignment, @modules/@subworkflows completeness, and valid @citation keys to enforce documentation standards across the codebase.

Do I need conda to run a GroovyDoc audit across modules and subworkflows?

Yes, you need conda installed as a dependency to run a GroovyDoc audit across modules and subworkflows. Along with bactopia-lint, conda provides the environment required to execute the validation scripts that surface documentation drift and check tag ordering.