( )⚙ D1119 releasenotes: fix documentation of similaritycheck()

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1119

releasenotes: fix documentation of similaritycheck()
ClosedPublic

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

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG070ba789f4d0: releasenotes: fix documentation of similaritycheck()
rHG735153be8151: releasenotes: fix documentation of similaritycheck()
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
Closed by commit rHG735153be8151: releasenotes: fix documentation of similaritycheck() (authored by pulkit). · Explain WhyOct 16 2017, 9:46 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.

pulkit added a comment.Oct 17 2017, 9:46 AM
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.

Revision Contents
Changeset List

PathPackages
Mhgext/releasenotes.py (2 lines)

Diff 2860

hgext/releasenotes.py

return True return True
else: else:
return False return False
else: else:
return False return False
def similaritycheck(incoming_str, existingnotes): def similaritycheck(incoming_str, existingnotes):
""" """
Returns true when note fragment can be merged to existing notes. Returns false when note fragment can be merged to existing notes.
""" """
import fuzzywuzzy.fuzz as fuzz import fuzzywuzzy.fuzz as fuzz
merge = True merge = True
for bullet in existingnotes: for bullet in existingnotes:
score = fuzz.token_set_ratio(incoming_str, bullet) score = fuzz.token_set_ratio(incoming_str, bullet)
if score > 75: if score > 75:
merge = False merge = False
break break