Rename compute_ngram_distance to _compute_ngram_distance#1838
Conversation
|
@rcap107 @jeromedockes can you review this pr? |
rcap107
left a comment
There was a problem hiding this comment.
There should be an entry in the changelog, explaining that the function is now private. Other than that and the other comment I left, the PR looks good.
|
|
||
|
|
||
| def test_compute_ngram_distance(): | ||
| def test__compute_ngram_distance(): |
There was a problem hiding this comment.
| def test__compute_ngram_distance(): | |
| def test_compute_ngram_distance(): |
| ------- | ||
|
|
||
| - :func:`compute_ngram_distance` has been renamed to :func:`_compute_ngram_distance` as it is a private function. | ||
| :pr:`1755` by :user:`Siddharth Baleja <siddharthbaleja>`. |
There was a problem hiding this comment.
| :pr:`1755` by :user:`Siddharth Baleja <siddharthbaleja>`. | |
| :pr:`1838` by :user:`Siddharth Baleja <siddharthbaleja>`. |
There was a problem hiding this comment.
the changelog should refer to the PR that is addressing the issue, not to the issue
|
FYI @siddharthbaleja7 if a comment is marked as "suggestion" on GitHub you can commit the suggestion directly by clicking on the button, rather than having do it manually in the code: It's not a big deal, just more convenient. |
|
Thanks for the tip! I'll definitely use that next time. |
rcap107
left a comment
There was a problem hiding this comment.
Looks good to me, thanks a lot @siddharthbaleja7
…1838) Co-authored-by: Riccardo Cappuzzo <riccardo.cappuzzo@gmail.com>
Co-authored-by: Riccardo Cappuzzo <riccardo.cappuzzo@gmail.com>
Renames compute_ngram_distance to _compute_ngram_distance to make it private, as requested in #1755.
Updates all internal usages, tests, and examples to use the new name.