Skip to content

Commit 5ae04ae

Browse files
committed
Run just-generate-docs
1 parent d16a4fc commit 5ae04ae

File tree

6 files changed

+264
-183
lines changed

6 files changed

+264
-183
lines changed

docs/includes/generated_docs/language__dataset.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ dataset.age = patients.age_on("2020-01-01")
2727
<div markdown="block" class="indent">
2828
To create a dataset use the [`create_dataset`](#create_dataset) function.
2929
<div class="attr-heading" id="Dataset.define_population">
30-
<tt><strong>define_population</strong>(<em>population_condition</em>)</tt>
30+
<tt>.<strong>define_population</strong>(<em>population_condition</em>)</tt>
3131
<a class="headerlink" href="#Dataset.define_population" title="Permanent link">🔗</a>
3232
</div>
3333
<div markdown="block" class="indent">
@@ -44,7 +44,7 @@ populations](../how-to/define-population.md).
4444
</div>
4545

4646
<div class="attr-heading" id="Dataset.add_column">
47-
<tt><strong>add_column</strong>(<em>column_name</em>, <em>ehrql_query</em>)</tt>
47+
<tt>.<strong>add_column</strong>(<em>column_name</em>, <em>ehrql_query</em>)</tt>
4848
<a class="headerlink" href="#Dataset.add_column" title="Permanent link">🔗</a>
4949
</div>
5050
<div markdown="block" class="indent">
@@ -68,7 +68,7 @@ over a dictionary. For more details see the guide on
6868
</div>
6969

7070
<div class="attr-heading" id="Dataset.configure_dummy_data">
71-
<tt><strong>configure_dummy_data</strong>(<em>population_size=10</em>, <em>legacy=False</em>, <em>timeout=60</em>, <em>additional_population_constraint=None</em>)</tt>
71+
<tt>.<strong>configure_dummy_data</strong>(<em>population_size=10</em>, <em>legacy=False</em>, <em>timeout=60</em>, <em>additional_population_constraint=None</em>)</tt>
7272
<a class="headerlink" href="#Dataset.configure_dummy_data" title="Permanent link">🔗</a>
7373
</div>
7474
<div markdown="block" class="indent">

docs/includes/generated_docs/language__date_arithmetic.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ Represents the difference between two dates or date series (i.e. it is what you
77
get when you perform subtractions on [DatePatientSeries](#DatePatientSeries.sub)
88
or [DateEventSeries](#DateEventSeries.sub)).
99
<div class="attr-heading" id="DateDifference.days">
10-
<tt><strong>days</strong></tt>
10+
<tt>.<strong>days</strong></tt>
1111
<a class="headerlink" href="#DateDifference.days" title="Permanent link">🔗</a>
1212
</div>
1313
<div markdown="block" class="indent">
1414
The value of the date difference in days (can be positive or negative).
1515
</div>
1616

1717
<div class="attr-heading" id="DateDifference.weeks">
18-
<tt><strong>weeks</strong></tt>
18+
<tt>.<strong>weeks</strong></tt>
1919
<a class="headerlink" href="#DateDifference.weeks" title="Permanent link">🔗</a>
2020
</div>
2121
<div markdown="block" class="indent">
2222
The value of the date difference in whole weeks (can be positive or negative).
2323
</div>
2424

2525
<div class="attr-heading" id="DateDifference.months">
26-
<tt><strong>months</strong></tt>
26+
<tt>.<strong>months</strong></tt>
2727
<a class="headerlink" href="#DateDifference.months" title="Permanent link">🔗</a>
2828
</div>
2929
<div markdown="block" class="indent">
@@ -32,7 +32,7 @@ negative).
3232
</div>
3333

3434
<div class="attr-heading" id="DateDifference.years">
35-
<tt><strong>years</strong></tt>
35+
<tt>.<strong>years</strong></tt>
3636
<a class="headerlink" href="#DateDifference.years" title="Permanent link">🔗</a>
3737
</div>
3838
<div markdown="block" class="indent">
@@ -105,7 +105,7 @@ if it was originally forwards, and vice versa.
105105
</div>
106106

107107
<div class="attr-heading" id="days.starting_on">
108-
<tt><strong>starting_on</strong>(<em>date</em>)</tt>
108+
<tt>.<strong>starting_on</strong>(<em>date</em>)</tt>
109109
<a class="headerlink" href="#days.starting_on" title="Permanent link">🔗</a>
110110
</div>
111111
<div markdown="block" class="indent">
@@ -129,7 +129,7 @@ Useful for generating the `intervals` arguments to [`Measures`](#Measures).
129129
</div>
130130

131131
<div class="attr-heading" id="days.ending_on">
132-
<tt><strong>ending_on</strong>(<em>date</em>)</tt>
132+
<tt>.<strong>ending_on</strong>(<em>date</em>)</tt>
133133
<a class="headerlink" href="#days.ending_on" title="Permanent link">🔗</a>
134134
</div>
135135
<div markdown="block" class="indent">
@@ -220,7 +220,7 @@ if it was originally forwards, and vice versa.
220220
</div>
221221

222222
<div class="attr-heading" id="months.starting_on">
223-
<tt><strong>starting_on</strong>(<em>date</em>)</tt>
223+
<tt>.<strong>starting_on</strong>(<em>date</em>)</tt>
224224
<a class="headerlink" href="#months.starting_on" title="Permanent link">🔗</a>
225225
</div>
226226
<div markdown="block" class="indent">
@@ -244,7 +244,7 @@ Useful for generating the `intervals` arguments to [`Measures`](#Measures).
244244
</div>
245245

246246
<div class="attr-heading" id="months.ending_on">
247-
<tt><strong>ending_on</strong>(<em>date</em>)</tt>
247+
<tt>.<strong>ending_on</strong>(<em>date</em>)</tt>
248248
<a class="headerlink" href="#months.ending_on" title="Permanent link">🔗</a>
249249
</div>
250250
<div markdown="block" class="indent">
@@ -332,7 +332,7 @@ if it was originally forwards, and vice versa.
332332
</div>
333333

334334
<div class="attr-heading" id="weeks.starting_on">
335-
<tt><strong>starting_on</strong>(<em>date</em>)</tt>
335+
<tt>.<strong>starting_on</strong>(<em>date</em>)</tt>
336336
<a class="headerlink" href="#weeks.starting_on" title="Permanent link">🔗</a>
337337
</div>
338338
<div markdown="block" class="indent">
@@ -356,7 +356,7 @@ Useful for generating the `intervals` arguments to [`Measures`](#Measures).
356356
</div>
357357

358358
<div class="attr-heading" id="weeks.ending_on">
359-
<tt><strong>ending_on</strong>(<em>date</em>)</tt>
359+
<tt>.<strong>ending_on</strong>(<em>date</em>)</tt>
360360
<a class="headerlink" href="#weeks.ending_on" title="Permanent link">🔗</a>
361361
</div>
362362
<div markdown="block" class="indent">
@@ -447,7 +447,7 @@ if it was originally forwards, and vice versa.
447447
</div>
448448

449449
<div class="attr-heading" id="years.starting_on">
450-
<tt><strong>starting_on</strong>(<em>date</em>)</tt>
450+
<tt>.<strong>starting_on</strong>(<em>date</em>)</tt>
451451
<a class="headerlink" href="#years.starting_on" title="Permanent link">🔗</a>
452452
</div>
453453
<div markdown="block" class="indent">
@@ -471,7 +471,7 @@ Useful for generating the `intervals` arguments to [`Measures`](#Measures).
471471
</div>
472472

473473
<div class="attr-heading" id="years.ending_on">
474-
<tt><strong>ending_on</strong>(<em>date</em>)</tt>
474+
<tt>.<strong>ending_on</strong>(<em>date</em>)</tt>
475475
<a class="headerlink" href="#years.ending_on" title="Permanent link">🔗</a>
476476
</div>
477477
<div markdown="block" class="indent">

docs/includes/generated_docs/language__frames.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<div markdown="block" class="indent">
66
Frame containing at most one row per patient.
77
<div class="attr-heading" id="PatientFrame.exists_for_patient">
8-
<tt><strong>exists_for_patient</strong>()</tt>
8+
<tt>.<strong>exists_for_patient</strong>()</tt>
99
<a class="headerlink" href="#PatientFrame.exists_for_patient" title="Permanent link">🔗</a>
1010
</div>
1111
<div markdown="block" class="indent">
@@ -19,7 +19,7 @@ pratice_registrations.for_patient_on("2020-01-01").exists_for_patient()
1919
</div>
2020

2121
<div class="attr-heading" id="PatientFrame.count_for_patient">
22-
<tt><strong>count_for_patient</strong>()</tt>
22+
<tt>.<strong>count_for_patient</strong>()</tt>
2323
<a class="headerlink" href="#PatientFrame.count_for_patient" title="Permanent link">🔗</a>
2424
</div>
2525
<div markdown="block" class="indent">
@@ -45,7 +45,7 @@ clinical_events.where(clinical_events.date.year == 2020).count_for_patient()
4545
<div markdown="block" class="indent">
4646
Frame which may contain multiple rows per patient.
4747
<div class="attr-heading" id="EventFrame.where">
48-
<tt><strong>where</strong>(<em>condition</em>)</tt>
48+
<tt>.<strong>where</strong>(<em>condition</em>)</tt>
4949
<a class="headerlink" href="#EventFrame.where" title="Permanent link">🔗</a>
5050
</div>
5151
<div markdown="block" class="indent">
@@ -61,7 +61,7 @@ clinical_events.where(clinical_events.date >= "2020-01-01")
6161
</div>
6262

6363
<div class="attr-heading" id="EventFrame.except_where">
64-
<tt><strong>except_where</strong>(<em>condition</em>)</tt>
64+
<tt>.<strong>except_where</strong>(<em>condition</em>)</tt>
6565
<a class="headerlink" href="#EventFrame.except_where" title="Permanent link">🔗</a>
6666
</div>
6767
<div markdown="block" class="indent">
@@ -79,7 +79,7 @@ as the latter would exclude rows where `condition` is NULL.
7979
</div>
8080

8181
<div class="attr-heading" id="EventFrame.sort_by">
82-
<tt><strong>sort_by</strong>(<em>*sort_values</em>)</tt>
82+
<tt>.<strong>sort_by</strong>(<em>*sort_values</em>)</tt>
8383
<a class="headerlink" href="#EventFrame.sort_by" title="Permanent link">🔗</a>
8484
</div>
8585
<div markdown="block" class="indent">
@@ -100,7 +100,7 @@ clinical_events.sort_by(clinical_events.date, clinical_events.snomedct_code)
100100
</div>
101101

102102
<div class="attr-heading" id="EventFrame.exists_for_patient">
103-
<tt><strong>exists_for_patient</strong>()</tt>
103+
<tt>.<strong>exists_for_patient</strong>()</tt>
104104
<a class="headerlink" href="#EventFrame.exists_for_patient" title="Permanent link">🔗</a>
105105
</div>
106106
<div markdown="block" class="indent">
@@ -114,7 +114,7 @@ pratice_registrations.for_patient_on("2020-01-01").exists_for_patient()
114114
</div>
115115

116116
<div class="attr-heading" id="EventFrame.count_for_patient">
117-
<tt><strong>count_for_patient</strong>()</tt>
117+
<tt>.<strong>count_for_patient</strong>()</tt>
118118
<a class="headerlink" href="#EventFrame.count_for_patient" title="Permanent link">🔗</a>
119119
</div>
120120
<div markdown="block" class="indent">
@@ -141,7 +141,7 @@ clinical_events.where(clinical_events.date.year == 2020).count_for_patient()
141141
Frame which contains multiple rows per patient and has had one or more sort
142142
operations applied.
143143
<div class="attr-heading" id="SortedEventFrame.where">
144-
<tt><strong>where</strong>(<em>condition</em>)</tt>
144+
<tt>.<strong>where</strong>(<em>condition</em>)</tt>
145145
<a class="headerlink" href="#SortedEventFrame.where" title="Permanent link">🔗</a>
146146
</div>
147147
<div markdown="block" class="indent">
@@ -157,7 +157,7 @@ clinical_events.where(clinical_events.date >= "2020-01-01")
157157
</div>
158158

159159
<div class="attr-heading" id="SortedEventFrame.except_where">
160-
<tt><strong>except_where</strong>(<em>condition</em>)</tt>
160+
<tt>.<strong>except_where</strong>(<em>condition</em>)</tt>
161161
<a class="headerlink" href="#SortedEventFrame.except_where" title="Permanent link">🔗</a>
162162
</div>
163163
<div markdown="block" class="indent">
@@ -175,7 +175,7 @@ as the latter would exclude rows where `condition` is NULL.
175175
</div>
176176

177177
<div class="attr-heading" id="SortedEventFrame.sort_by">
178-
<tt><strong>sort_by</strong>(<em>*sort_values</em>)</tt>
178+
<tt>.<strong>sort_by</strong>(<em>*sort_values</em>)</tt>
179179
<a class="headerlink" href="#SortedEventFrame.sort_by" title="Permanent link">🔗</a>
180180
</div>
181181
<div markdown="block" class="indent">
@@ -196,7 +196,7 @@ clinical_events.sort_by(clinical_events.date, clinical_events.snomedct_code)
196196
</div>
197197

198198
<div class="attr-heading" id="SortedEventFrame.exists_for_patient">
199-
<tt><strong>exists_for_patient</strong>()</tt>
199+
<tt>.<strong>exists_for_patient</strong>()</tt>
200200
<a class="headerlink" href="#SortedEventFrame.exists_for_patient" title="Permanent link">🔗</a>
201201
</div>
202202
<div markdown="block" class="indent">
@@ -210,7 +210,7 @@ pratice_registrations.for_patient_on("2020-01-01").exists_for_patient()
210210
</div>
211211

212212
<div class="attr-heading" id="SortedEventFrame.count_for_patient">
213-
<tt><strong>count_for_patient</strong>()</tt>
213+
<tt>.<strong>count_for_patient</strong>()</tt>
214214
<a class="headerlink" href="#SortedEventFrame.count_for_patient" title="Permanent link">🔗</a>
215215
</div>
216216
<div markdown="block" class="indent">
@@ -227,7 +227,7 @@ clinical_events.where(clinical_events.date.year == 2020).count_for_patient()
227227
</div>
228228

229229
<div class="attr-heading" id="SortedEventFrame.first_for_patient">
230-
<tt><strong>first_for_patient</strong>()</tt>
230+
<tt>.<strong>first_for_patient</strong>()</tt>
231231
<a class="headerlink" href="#SortedEventFrame.first_for_patient" title="Permanent link">🔗</a>
232232
</div>
233233
<div markdown="block" class="indent">
@@ -246,7 +246,7 @@ medications.sort_by(medications.date).first_for_patient()
246246
</div>
247247

248248
<div class="attr-heading" id="SortedEventFrame.last_for_patient">
249-
<tt><strong>last_for_patient</strong>()</tt>
249+
<tt>.<strong>last_for_patient</strong>()</tt>
250250
<a class="headerlink" href="#SortedEventFrame.last_for_patient" title="Permanent link">🔗</a>
251251
</div>
252252
<div markdown="block" class="indent">

docs/includes/generated_docs/language__measures.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ measures.define_measure(
2828
<div markdown="block" class="indent">
2929
To create a collection of measures use the [`create_measures`](#create_measures) function.
3030
<div class="attr-heading" id="Measures.define_measure">
31-
<tt><strong>define_measure</strong>(<em>name</em>, <em>numerator=None</em>, <em>denominator=None</em>, <em>group_by=None</em>, <em>intervals=None</em>)</tt>
31+
<tt>.<strong>define_measure</strong>(<em>name</em>, <em>numerator=None</em>, <em>denominator=None</em>, <em>group_by=None</em>, <em>intervals=None</em>)</tt>
3232
<a class="headerlink" href="#Measures.define_measure" title="Permanent link">🔗</a>
3333
</div>
3434
<div markdown="block" class="indent">
@@ -78,7 +78,7 @@ default values for them have been set using
7878
</div>
7979

8080
<div class="attr-heading" id="Measures.define_defaults">
81-
<tt><strong>define_defaults</strong>(<em>numerator=None</em>, <em>denominator=None</em>, <em>group_by=None</em>, <em>intervals=None</em>)</tt>
81+
<tt>.<strong>define_defaults</strong>(<em>numerator=None</em>, <em>denominator=None</em>, <em>group_by=None</em>, <em>intervals=None</em>)</tt>
8282
<a class="headerlink" href="#Measures.define_defaults" title="Permanent link">🔗</a>
8383
</div>
8484
<div markdown="block" class="indent">
@@ -97,7 +97,7 @@ this method more than once is an error.
9797
</div>
9898

9999
<div class="attr-heading" id="Measures.configure_dummy_data">
100-
<tt><strong>configure_dummy_data</strong>(<em>population_size=10</em>, <em>legacy=False</em>, <em>timeout=60</em>, <em>additional_population_constraint=None</em>)</tt>
100+
<tt>.<strong>configure_dummy_data</strong>(<em>population_size=10</em>, <em>legacy=False</em>, <em>timeout=60</em>, <em>additional_population_constraint=None</em>)</tt>
101101
<a class="headerlink" href="#Measures.configure_dummy_data" title="Permanent link">🔗</a>
102102
</div>
103103
<div markdown="block" class="indent">
@@ -135,7 +135,7 @@ measures.configure_dummy_data(population_size=10000)
135135
</div>
136136

137137
<div class="attr-heading" id="Measures.configure_disclosure_control">
138-
<tt><strong>configure_disclosure_control</strong>(<em>enabled=True</em>)</tt>
138+
<tt>.<strong>configure_disclosure_control</strong>(<em>enabled=True</em>)</tt>
139139
<a class="headerlink" href="#Measures.configure_disclosure_control" title="Permanent link">🔗</a>
140140
</div>
141141
<div markdown="block" class="indent">

0 commit comments

Comments
 (0)