From 5edc50dae20a53ffafaf7c4bd30724bcaa2de070 Mon Sep 17 00:00:00 2001 From: William Palin Date: Wed, 22 Jan 2025 16:34:24 -0500 Subject: [PATCH] chore(filter_citations): Update docstring --- eyecite/helpers.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/eyecite/helpers.py b/eyecite/helpers.py index 996f789..9ab88f5 100644 --- a/eyecite/helpers.py +++ b/eyecite/helpers.py @@ -318,7 +318,12 @@ def disambiguate_reporters( def filter_citations(citations: List[CitationBase]) -> List[CitationBase]: - """Filter and order citations that may have reference cites out of order + """Filter and order citations, ensuring reference citations are in sequence + + This function resolves rare but possible overlaps between ref. citations + and short citations. It also orders all citations by their `citation.span`, + as reference citations may be extracted out of order. The final result is a + properly sorted list of citations as they appear in the text :param citations: List of citations :return: Sorted and filtered citations