Merge pull request #2105 from opensafely-core/evansd/docs-tweak

Fix clumsy sentence in docs
opensafely-core · Sep 11, 2024 · ad304d3 · ad304d3
2 parents 171c23c + 946bf70
commit ad304d3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/includes/generated_docs/language__series.md b/docs/includes/generated_docs/language__series.md
@@ -2007,8 +2007,9 @@ has no values).
 </div>
 <div markdown="block" class="indent">
 Counts the number of "episodes" for each patient where dates which are no more
-than `maximum_gap` apart (specified in [`days()`](#days) or [`weeks()`](#weeks))
-are considered part of the same episode.
+than `maximum_gap` apart are considered part of the same episode. The
+`maximum_gap` duration can be specified in [`days()`](#days) or
+[`weeks()`](#weeks).
 
 For example, suppose a patient has the following sequence of events:
 

diff --git a/ehrql/query_language.py b/ehrql/query_language.py
@@ -720,8 +720,9 @@ class DateAggregations(ComparableAggregations):
     def count_episodes_for_patient(self, maximum_gap):
         """
         Counts the number of "episodes" for each patient where dates which are no more
-        than `maximum_gap` apart (specified in [`days()`](#days) or [`weeks()`](#weeks))
-        are considered part of the same episode.
+        than `maximum_gap` apart are considered part of the same episode. The
+        `maximum_gap` duration can be specified in [`days()`](#days) or
+        [`weeks()`](#weeks).
 
         For example, suppose a patient has the following sequence of events: