Update function-decomposition.qmd

[d-morrison]

No description provided.

[Copilot]

Pull request overview

Updates the “When to decompose a function” guidance in the lab manual to use more general wording, improving clarity while keeping the intent of the checklist the same.

Changes:

• Reworded one decomposition criterion from “top-level function” to “current function” for broader applicability.

[github-actions]

PR Preview Action v1.8.1-2-g6ad689f
🚀 View preview at https://UCD-SERG.github.io/lab-manual/pr-preview/pr-290/
Built to branch gh-pages at 2026-06-17 17:27 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[d-morrison]

@claude review

[claude]

Claude finished @d-morrison's task in 25s —— View job

---

Code Review

• Gather context
• Read changed file and diff
• Provide review feedback

---

The change is a single-line wording improvement in coding-practices/function-decomposition.qmd:23:

Before: The top-level function is hard to scan because implementation details hide the main idea
After: The current function is hard to scan because implementation details hide the main idea

Assessment: Looks good.

The original phrase "top-level function" was ambiguous — it could be read as referring only to the outermost function in a call hierarchy, whereas the intent is to apply to any function being considered for decomposition. Changing it to "current function" makes the checklist item applicable at any level of nesting, which is more accurate and consistent with the rest of the checklist (which uses second-person "you" constructions throughout).

The change is minimal, correct, and improves clarity without altering the meaning or introducing any inconsistencies elsewhere in the document.

[d-morrison]

Claude Code CLI (local session) is working on this — paws off until I'm done.

[d-morrison]

@claude review

[claude]

Claude finished @d-morrison's task in 37s —— View job

---

Code Review

• Gather context
• Read changed file and diff
• Provide review feedback

---

File reviewed: coding-practices/function-decomposition.qmd

Change (line 23):

- The top-level function is hard to scan because implementation details hide the main idea
+ The current function is hard to scan because implementation details hide the main idea

Assessment: Looks good. ✓

The wording change is a clear improvement:

• "top-level function" is ambiguous — it implies the checklist item only applies to the outermost function in a hierarchy, which is too narrow.
• "current function" is more accurate — it makes the criterion applicable at any level of nesting, which matches how decomposition is actually practiced (you decompose whichever function you're working on, regardless of depth).

The rest of the document is well-structured. The checklist items use consistent second-person framing ("you are repeating…", "you need comments…", "you want to test…"), and "current function" fits naturally into that voice without requiring any other edits.

No issues found. This is ready to merge.

---