Skip to content

Commit d838bec

Browse files
committed
update docstring
1 parent 54097ee commit d838bec

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/academic_tracker/helper_functions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,7 @@ def _compute_common_phrase_percent(prev_citation, new_citation, characters_to_re
669669
min_len (int): the minimum length of a subphrase.
670670
671671
Returns:
672-
((int, int)|None): if either citation is None, then return None, else the percentage of common to uncommon phrase length for each citation.
672+
((int, int)|None): if either citation is None or empty after character removal and stripping, then return None, else the percentage of common to uncommon phrase length for each citation.
673673
"""
674674
if prev_citation and new_citation:
675675
citation_strip_regex = "|".join([f"\{char}" for char in characters_to_remove])

0 commit comments

Comments
 (0)