Research-Stack/5-Applications/nodupe/docs/plans/DOCSTRING_COMPLETION_PLAN.md
2026-05-05 21:15:26 -05:00

1.8 KiB

Docstring Coverage Plan - 100% Target

Summary

  • Total Missing: 1,690 docstrings
  • Current Coverage: 86.7%
  • Target Coverage: 100%

Files to Fix (by category)

1. Test Utility Files (tests/utils/)

  • tests/utils/errors.py - 30 missing (inner classes and helper functions)
  • tests/utils/performance.py - 14 missing
  • tests/utils/validation.py - 2 missing

2. Root Test Files

  • tests/init.py - 1 missing (module-level)
  • tests/core/init.py - 1 missing (module-level)
  • tests/ipc_socket_utils.py - 2 missing
  • tests/test_import.py - 1 missing (module-level)

3. Test Core Files

  • tests/core/test_compression.py - 12 missing
  • tests/core/test_loader_coverage.py - 37 missing
  • tests/core/test_tool_base_coverage.py - 9 missing
  • tests/core/test_compatibility_coverage.py - 47 missing
  • tests/core/test_discovery_coverage.py - 42 missing
  • tests/core/test_plugins.py - 52 missing
  • tests/core/test_coverage_gaps.py - 52 missing
  • tests/core/test_tool_loader.py - 37 missing

4. Test Plugin Files

  • tests/plugins/test_plugin_compatibility.py - 140 missing (helper classes)
  • tests/plugins/test_plugin_lifecycle.py - 127 missing (helper classes)
  • tests/plugins/test_plugin_loader.py - 74 missing

5. Test Parallel Files

  • tests/parallel/test_parallel_logic.py - 119 missing (nested helpers)
  • tests/parallel/test_pools.py - 93 missing (nested helpers)

6. Production Code (nodupe/)

  • nodupe/core/loader.py - inner classes
  • nodupe/core/api/decorators.py - inner functions
  • output/ci_artifacts/setup.py - 1 missing

Strategy

  1. Start with simplest fixes (module-level docstrings)
  2. Move to production code fixes
  3. Handle test files systematically
  4. Use subagents for parallel work on different categories