wiki / coding-explain-unfamiliar-code / edit

Suggest an edit.

Improvements are reviewed before going live, like any wiki.

Title

One-line summary

The prompt

Explain the following [LANGUAGE] code to me. I did not write it and I need to modify it safely.

Structure your explanation in this order:
1. Purpose: one paragraph on what this code does and where it likely fits in a larger system.
2. Walkthrough: trace the execution flow top to bottom. For each function or block, state what goes in, what comes out, and any state it reads or mutates.
3. Non-obvious details: anything a reader would likely miss — implicit assumptions, side effects, error handling gaps, concurrency concerns, magic values, or behavior that depends on runtime or library version.
4. Vocabulary: define any patterns or idioms the code uses (memoization, dependency injection, etc.) in one sentence each, only if they actually appear here.
5. Risk map: which parts are safe to change casually, and which parts look load-bearing or fragile. Say why.

Rules: do not paraphrase code line by line when the line is self-explanatory; spend words only where understanding is at risk. If something is ambiguous without more context, say exactly what file or definition you would need to see. Do not guess at intent silently — label every inference as an inference.

My current understanding, so you can target the gaps: [ONE SENTENCE ON WHAT YOU THINK IT DOES, OR "NONE"]

Code:
[PASTE CODE]

Write it so someone can paste it straight into Claude, ChatGPT or Gemini and fill the [BRACKETS].