Adjust patchProp value arguments order

refactor(runtime-core): adjust patchProp value arguments order
Adjust patchProp value arguments orderrefactoradjust patchprop value arguments order runtime

Committed by yyx990803

commit message
refactor(runtime-core)!: adjust patchProp value arguments order

BREAKING CHANGE: `RendererOptions.patchProp` arguments order has changed
 
  The `prevValue` and `nextValue` position has been swapped to keep it
  consistent with other functions in the renderer implementation. This
  only affects custom renderers using the `createRenderer` API.

Editor assessment

refactor(runtime-core) announces an argument-order change for RendererOptions.patchProp, and the BREAKING CHANGE footer explains the swap of prevValue and nextValue, why consistency with other renderer functions drove it, and that only custom renderers using createRenderer are affected. That is impact plus audience plus motivation, satisfying the breaking-change content requirement. The footer is well formed, the header is imperative and unterminated, and nothing is pasted. A model example of documenting a subtle API break.

Browse categories

More refactor examples · Back to search