review-script

Analyze Python scripts for documentation quality, coding standards, and reproducibility.

3|Updated Dec 3, 2025

Search Tags:#documentation #python #quality #review #scripts #code #reproducibility

Ready to run

npx skills add https://github.com/braselog/researchAssistant --skill review-script

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: review-script
Source: https://github.com/braselog/researchAssistant/tree/main/.ra/skills/review-script
Command: npx skills add https://github.com/braselog/researchAssistant --skill review-script

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill helps ensure code scripts are well-documented, adhere to standards, and are reproducible, enabling smoother method sections and repeatable analyses.

Core Features & Use Cases

Documentation Audit: Review module and function docstrings, inline comments, and usage examples.
Code Quality & Reproducibility: Check for seeds, configurable parameters, and dependency integrity.
Use Case: Before adding a new preprocessing script to a project, run this Skill to verify documentation and reproducibility readiness.

Quick Start

Use this Skill after creating or updating a script to generate a comprehensive documentation and quality report, e.g., /review_script scripts/preprocess.py or /review_script scripts/

Frequently Asked Questions about review-script

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

FAQPage Schema

How do I check if a Python script has docstrings and comments for audit trails?▼

Check Python script documentation by analyzing files to verify module and function docstrings, inline comments, and usage examples. This documentation review ensures scripts meet coding standards and are ready for methods sections and audit trails.

What's the best way to verify reproducibility in Python scripts before adding them to a project?▼

Verify Python script reproducibility by checking for configurable parameters, random seeds, and dependency integrity. Reviewing these elements ensures your preprocessing scripts meet quality standards and can be reliably repeated during future analyses.

Can I review multiple Python scripts in a directory at once for documentation quality?▼

Yes, you can review multiple Python scripts by targeting an entire directory instead of a single file. The analysis applies documentation and reproducibility checks across all scripts within the specified folder to generate a comprehensive quality report.

Does a Python documentation audit check for configurable parameters and dependency integrity?▼

Yes, a Python documentation audit checks for configurable parameters and dependency integrity alongside module docstrings and inline comments. These checks validate coding standards, parameter configurability, and overall script reproducibility for audit trails.

When do I need to run a code quality and reproducibility check on my preprocessing scripts?▼

Run a code quality and reproducibility check after creating or updating a preprocessing script. This review verifies documentation completeness and reproducibility readiness, ensuring your Python scripts are prepared for method sections and repeatable analyses.