Format a hygiene report for Markdown review

Direct answer

A Markdown hygiene report should not hide all meaning in one score. Each row here carries a stable identifier, a status, and a short detail, while a separate Limits heading states the scope. Constructing a list of lines avoids accidental spacing changes and gives reviewers a predictable order.

The edge case is a formatter that omits its limits section during a visual cleanup. The final assertion checks the exact ending, so the filename-only boundary cannot disappear while the check rows still look healthy. The output remains readable in a pull request without asking a reader to infer the scanner’s assumptions.

This example formats trusted synthetic fields only. It does not escape arbitrary Markdown, wrap long error messages, or decide how warnings affect a release. Escape values before rendering if filenames or details can contain Markdown control characters. The formatting contract is intentionally narrower than a full reporting system.

Complete example

from dataclasses import dataclass


@dataclass(frozen=True)
class Check:
    identifier: str
    status: str
    detail: str


checks = [
    Check("root-readme", "pass", "README.md found"),
    Check("env-files", "warn", "names only"),
]
lines = ["# Hygiene report", ""]
lines.extend(
    f"- `{check.identifier}`: **{check.status}** — {check.detail}"
    for check in checks
)
lines.extend(["", "## Limits", "- Filenames only"])
report = "\n".join(lines) + "\n"
assert "`root-readme`: **pass**" in report
assert report.endswith("- Filenames only\n")
print(report, end="")

Expected stdout:

# Hygiene report

- `root-readme`: **pass** — README.md found
- `env-files`: **warn** — names only

## Limits
- Filenames only

Sources

- Official API documentation

Prepared with AI assistance. The example uses synthetic data; its stated limits apply.

Comments

Post a Comment

Popular posts from this blog

Compare Two Text Files in Python Without Modifying Them

Batu Lab Notes · Batu When comparing two versions of a configuration or notes file, “are they the same?” is only the first question. The bytes may be identical, the visible text may be equal despite different line endings, or the content may contain a real change. For small UTF-8 text files, Python’s standard library can show these distinctions without writing to either input. Quick answer For small, stable UTF-8 files, read bounded bytes, compare them first, then decode and produce a bounded unified diff. Decide explicitly whether newline differences matter. Keep both inputs read-only and review the diff for private data before sharing it. Set a limit before reading Loading an input of unknown size directly into memory is a poor default. This example checks both sizes with Path.stat() , then performs a bounded read and applies a 256 KiB limit per file. It rejects directories and other non-regular paths. If reading raises OSError , the result includes the exception ty...
Read more

Seven CSV Quality Checks to Run Before Importing Data

Batu Lab Notes · Batu A CSV file is not ready for import merely because it opens. The wrong delimiter can collapse an entire row into one column. An unexpected encoding can damage non-ASCII characters. A repeated identifier can overwrite an existing record in the destination. A short, read-only check makes these problems visible before data reaches a spreadsheet or application. Quick answer Before importing a CSV, set its encoding and delimiter, validate the exact header and every row width, distinguish empty IDs, duplicate IDs, and duplicate rows, and keep the check read-only. 1. Specify the encoding Python may open a text file with the platform’s default encoding, which can differ across machines. If the expected encoding is UTF-8, encoding="utf-8-sig" is a practical choice: it reads ordinary UTF-8 and skips an optional UTF-8 byte order mark at the start. If decoding fails, verify the source application’s export settings instead of silently trying unrelat...
Read more

Explain why SQLite transactions cannot make an HTTP call atomic

Direct answer A SQLite transaction can atomically commit database statements handled by that connection. It cannot include an HTTP service in the same commit protocol. The example commits an outbox row first, then simulates a network failure. The durable row remains pending , which is exactly the information a later delivery worker needs instead of pretending both actions succeeded or failed together. The edge case is failure after the database commit but before remote acknowledgement. Retrying then requires an idempotency design owned by the remote endpoint or a stable request key; it is not supplied by SQLite’s COMMIT . Conversely, sending the request before storing a durable intent can leave no local evidence when the process stops. This demonstration intentionally does not make an HTTP request, implement an outbox dispatcher, or prove delivery exactly once. It shows the boundary that must be designed around. Use transactions to protect the local state transition, and test remote...
Read more