ReadsHuman
#25 of 25

Writing about the previous version

Documentation and comments describe what the text replaced instead of the current behavior. Mention the previous version only in change logs, release notes, migration guides, and other documents about change.

Before and after.

Before

This function was added to replace the previous approach of iterating through all items, which caused O(n²) performance.

After

This function uses a hash map for O(1) lookups, avoiding the O(n²) cost of naive iteration.

Is this one in your draft?

Paste it in. If it’s there, it gets marked with this exact reason.

Check my draft