This is an archive of the discontinued Mercurial Phabricator instance.

releasenotes: fix documentation of similaritycheck()
ClosedPublic

Authored by pulkit on Oct 16 2017, 2:28 PM.

Details

Summary

The function document says that it returns true when the fragment can be merged,
but if you see the function just above it which is similar(), it writes already
exists thing if return value from similaritycheck() is False which is just
opposite of the doc. This patch fixes that.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

pulkit created this revision.Oct 16 2017, 2:28 PM
durin42 accepted this revision.Oct 16 2017, 9:04 PM
This revision is now accepted and ready to land.Oct 16 2017, 9:04 PM
This revision was automatically updated to reflect the committed changes.
yuja added a subscriber: yuja.Oct 17 2017, 9:40 AM

I guess the original intent was s/merged to/included in/. The return value
is named "merge", which is set to False if similarity is high.

In D1119#19228, @yuja wrote:

I guess the original intent was s/merged to/included in/. The return value
is named "merge", which is set to False if similarity is high.

Ah, the wording is confusing here. I will follow-up with clearing that.