liveBook · Manning

Result

As explained in "Looks Good to Me"

The part of a code-review comment that specifies the measurable end state expected after a change.

A result is the measurable end state specified in a code-review comment. It completes the Triple-R pattern: request what should change, rationale for why, and result for comparing the author's revision against an expected outcome. section 6.1.3

Make the expected state concrete:

  • State a metric to reach, a screenshot of the intended state, or what the code should look like afterward. section 6.1.3
  • For a moved method: “Calls to AuthenticateUser() should be through the library rather than a standalone declaration.” section 6.1.3
  • For a loop change: “The map is replaced with a for loop on line 32.” section 6.1.3

How "Looks Good to Me" covers it

How deep it goes
Defines result and demonstrates it through method-placement and loop-replacement examples.
Examples
Uses library placement, loop replacement, metrics, screenshots, and intended post-change code as concrete forms.
What you can do after
Apply it via the Triple-R pattern to state a review change's measurable end state.
How it connects
Connects result with code-review comments, requests, rationale, and the Triple-R pattern.
Cover of "Looks Good to Me"
liveBookmanning.com
Read "Looks Good to Me" on liveBook Get the book at manning.com

This explainer was generated by Manning's knowledge graph from the text of "Looks Good to Me". The section links point to the parts of the book it draws on.