CtrlK
BlogDocsLog inGet started
Tessl Logo

akshay-babbar/doc-sync

Auto-syncs stale docstrings and README when function signatures change. Detects documentation drift after refactors, parameter additions, or return type changes. Dry-run by default — proposes before writing.

87

1.59x
Quality

100%

Does it follow best practices?

Impact

86%

1.59x

Average score across 17 eval scenarios

SecuritybySnyk

Passed

No known issues

Overview
Quality
Evals
Security
Files

task.mdevals/scenario-7/

Scenario: Docstring and README contradict; return type changes

A Python function calculate_fee has conflicting documentation: its docstring describes one return type/units while the README describes another. The function's return type annotation changed from -> int to -> Decimal.

You must:

  • Update the docstring to match the new return type.
  • Propose (not auto-write) the README update.
  • Surface the contradiction in the report — do not silently pick one source of truth.

Setup

Extract the following file and set up the git repository:

=============== FILE: inputs/setup.sh =============== #!/usr/bin/env bash set -euo pipefail

git init git config user.email "dev@example.com" git config user.name "Dev"

mkdir -p src

cat > src/fees.py << 'PYEOF' from future import annotations

def calculate_fee(amount_cents: int, rate_percent: int = 5) -> int: """Calculate a fee for a transaction.

Args:
    amount_cents: Amount in cents.
    rate_percent: Fee rate as an integer percent.

Returns:
    Fee in dollars as a float.
"""
return (amount_cents * rate_percent) // 100

PYEOF

cat > README.md << 'MDEOF'

Fees

calculate_fee returns an integer fee in cents.

Do not auto-apply markdown edits. MDEOF

git add -A && git commit -m "baseline"

cat > src/fees.py << 'PYEOF' from future import annotations

from decimal import Decimal

def calculate_fee(amount_cents: int, rate_percent: int = 5) -> Decimal: """Calculate a fee for a transaction.

Args:
    amount_cents: Amount in cents.
    rate_percent: Fee rate as an integer percent.

Returns:
    Fee in dollars as a float.
"""
return (Decimal(amount_cents) * Decimal(rate_percent)) / Decimal(100)

PYEOF

Output Specification

Sync the documentation and write the results to doc-sync-report.md.

evals

README.md

SKILL.md

tessl.json

tile.json

TRUST.md