1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc $VERSION"/>
<title>math_misc API documentation</title>
<style>/*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */*,::after,::before{box-sizing:border-box}@media (prefers-reduced-motion:no-preference){:root{scroll-behavior:smooth}}body{margin:0;font-family:system-ui,-apple-system,"Segoe UI",Roboto,"Helvetica Neue",Arial,"Noto Sans","Liberation Sans",sans-serif,"Apple Color Emoji","Segoe UI Emoji","Segoe UI Symbol","Noto Color Emoji";font-size:1rem;font-weight:400;line-height:1.5;color:#212529;background-color:#fff;-webkit-text-size-adjust:100%;-webkit-tap-highlight-color:transparent}hr{margin:1rem 0;color:inherit;background-color:currentColor;border:0;opacity:.25}hr:not([size]){height:1px}h1,h2,h3,h4,h5,h6{margin-top:0;margin-bottom:.5rem;font-weight:500;line-height:1.2}h1{font-size:calc(1.375rem + 1.5vw)}@media (min-width:1200px){h1{font-size:2.5rem}}h2{font-size:calc(1.325rem + .9vw)}@media (min-width:1200px){h2{font-size:2rem}}h3{font-size:calc(1.3rem + .6vw)}@media (min-width:1200px){h3{font-size:1.75rem}}h4{font-size:calc(1.275rem + .3vw)}@media (min-width:1200px){h4{font-size:1.5rem}}h5{font-size:1.25rem}h6{font-size:1rem}p{margin-top:0;margin-bottom:1rem}abbr[data-bs-original-title],abbr[title]{-webkit-text-decoration:underline dotted;text-decoration:underline dotted;cursor:help;-webkit-text-decoration-skip-ink:none;text-decoration-skip-ink:none}address{margin-bottom:1rem;font-style:normal;line-height:inherit}ol,ul{padding-left:2rem}dl,ol,ul{margin-top:0;margin-bottom:1rem}ol ol,ol ul,ul ol,ul ul{margin-bottom:0}dt{font-weight:700}dd{margin-bottom:.5rem;margin-left:0}blockquote{margin:0 0 1rem}b,strong{font-weight:bolder}small{font-size:.875em}mark{padding:.2em;background-color:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a:not([href]):not([class]),a:not([href]):not([class]):hover{color:inherit;text-decoration:none}code,kbd,pre,samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,"Liberation Mono","Courier New",monospace;font-size:1em;direction:ltr;unicode-bidi:bidi-override}pre{display:block;margin-top:0;margin-bottom:1rem;overflow:auto;font-size:.875em}pre code{font-size:inherit;color:inherit;word-break:normal}code{font-size:.875em;color:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-radius:.2rem}kbd kbd{padding:0;font-size:1em;font-weight:700}figure{margin:0 0 1rem}img,svg{vertical-align:middle}table{caption-side:bottom;border-collapse:collapse}caption{padding-top:.5rem;padding-bottom:.5rem;color:#6c757d;text-align:left}th{text-align:inherit;text-align:-webkit-match-parent}tbody,td,tfoot,th,thead,tr{border-color:inherit;border-style:solid;border-width:0}label{display:inline-block}button{border-radius:0}button:focus:not(:focus-visible){outline:0}button,input,optgroup,select,textarea{margin:0;font-family:inherit;font-size:inherit;line-height:inherit}button,select{text-transform:none}[role=button]{cursor:pointer}select{word-wrap:normal}select:disabled{opacity:1}[list]::-webkit-calendar-picker-indicator{display:none}[type=button],[type=reset],[type=submit],button{-webkit-appearance:button}[type=button]:not(:disabled),[type=reset]:not(:disabled),[type=submit]:not(:disabled),button:not(:disabled){cursor:pointer}::-moz-focus-inner{padding:0;border-style:none}textarea{resize:vertical}fieldset{min-width:0;padding:0;margin:0;border:0}legend{float:left;width:100%;padding:0;margin-bottom:.5rem;font-size:calc(1.275rem + .3vw);line-height:inherit}@media (min-width:1200px){legend{font-size:1.5rem}}legend+*{clear:left}::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-fields-wrapper,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-text,::-webkit-datetime-edit-year-field{padding:0}::-webkit-inner-spin-button{height:auto}[type=search]{outline-offset:-2px;-webkit-appearance:textfield}::-webkit-search-decoration{-webkit-appearance:none}::-webkit-color-swatch-wrapper{padding:0}::file-selector-button{font:inherit}::-webkit-file-upload-button{font:inherit;-webkit-appearance:button}output{display:inline-block}iframe{border:0}summary{display:list-item;cursor:pointer}progress{vertical-align:baseline}[hidden]{display:none!important}</style>
<style>/*! syntax-highlighting.css */pre{line-height:125%;}span.linenos{color:inherit; background-color:transparent; padding-left:5px; padding-right:20px;}.pdoc-code .hll{background-color:#ffffcc}.pdoc-code{background:#f8f8f8;}.pdoc-code .c{color:#3D7B7B; font-style:italic}.pdoc-code .err{border:1px solid #FF0000}.pdoc-code .k{color:#008000; font-weight:bold}.pdoc-code .o{color:#666666}.pdoc-code .ch{color:#3D7B7B; font-style:italic}.pdoc-code .cm{color:#3D7B7B; font-style:italic}.pdoc-code .cp{color:#9C6500}.pdoc-code .cpf{color:#3D7B7B; font-style:italic}.pdoc-code .c1{color:#3D7B7B; font-style:italic}.pdoc-code .cs{color:#3D7B7B; font-style:italic}.pdoc-code .gd{color:#A00000}.pdoc-code .ge{font-style:italic}.pdoc-code .gr{color:#E40000}.pdoc-code .gh{color:#000080; font-weight:bold}.pdoc-code .gi{color:#008400}.pdoc-code .go{color:#717171}.pdoc-code .gp{color:#000080; font-weight:bold}.pdoc-code .gs{font-weight:bold}.pdoc-code .gu{color:#800080; font-weight:bold}.pdoc-code .gt{color:#0044DD}.pdoc-code .kc{color:#008000; font-weight:bold}.pdoc-code .kd{color:#008000; font-weight:bold}.pdoc-code .kn{color:#008000; font-weight:bold}.pdoc-code .kp{color:#008000}.pdoc-code .kr{color:#008000; font-weight:bold}.pdoc-code .kt{color:#B00040}.pdoc-code .m{color:#666666}.pdoc-code .s{color:#BA2121}.pdoc-code .na{color:#687822}.pdoc-code .nb{color:#008000}.pdoc-code .nc{color:#0000FF; font-weight:bold}.pdoc-code .no{color:#880000}.pdoc-code .nd{color:#AA22FF}.pdoc-code .ni{color:#717171; font-weight:bold}.pdoc-code .ne{color:#CB3F38; font-weight:bold}.pdoc-code .nf{color:#0000FF}.pdoc-code .nl{color:#767600}.pdoc-code .nn{color:#0000FF; font-weight:bold}.pdoc-code .nt{color:#008000; font-weight:bold}.pdoc-code .nv{color:#19177C}.pdoc-code .ow{color:#AA22FF; font-weight:bold}.pdoc-code .w{color:#bbbbbb}.pdoc-code .mb{color:#666666}.pdoc-code .mf{color:#666666}.pdoc-code .mh{color:#666666}.pdoc-code .mi{color:#666666}.pdoc-code .mo{color:#666666}.pdoc-code .sa{color:#BA2121}.pdoc-code .sb{color:#BA2121}.pdoc-code .sc{color:#BA2121}.pdoc-code .dl{color:#BA2121}.pdoc-code .sd{color:#BA2121; font-style:italic}.pdoc-code .s2{color:#BA2121}.pdoc-code .se{color:#AA5D1F; font-weight:bold}.pdoc-code .sh{color:#BA2121}.pdoc-code .si{color:#A45A77; font-weight:bold}.pdoc-code .sx{color:#008000}.pdoc-code .sr{color:#A45A77}.pdoc-code .s1{color:#BA2121}.pdoc-code .ss{color:#19177C}.pdoc-code .bp{color:#008000}.pdoc-code .fm{color:#0000FF}.pdoc-code .vc{color:#19177C}.pdoc-code .vg{color:#19177C}.pdoc-code .vi{color:#19177C}.pdoc-code .vm{color:#19177C}.pdoc-code .il{color:#666666}</style>
<style>/*! theme.css */:root{--pdoc-background:#fff;}.pdoc{--text:#212529;--muted:#6c757d;--link:#3660a5;--link-hover:#1659c5;--code:#f8f8f8;--active:#fff598;--accent:#eee;--accent2:#c1c1c1;--nav-hover:rgba(255, 255, 255, 0.5);--name:#0066BB;--def:#008800;--annotation:#007020;}</style>
<style>/*! layout.css */html, body{width:100%;height:100%;}html, main{scroll-behavior:smooth;}body{background-color:var(--pdoc-background);}@media (max-width:769px){#navtoggle{cursor:pointer;position:absolute;width:50px;height:40px;top:1rem;right:1rem;border-color:var(--text);color:var(--text);display:flex;opacity:0.8;z-index:999;}#navtoggle:hover{opacity:1;}#togglestate + div{display:none;}#togglestate:checked + div{display:inherit;}main, header{padding:2rem 3vw;}header + main{margin-top:-3rem;}.git-button{display:none !important;}nav input[type="search"]{max-width:77%;}nav input[type="search"]:first-child{margin-top:-6px;}nav input[type="search"]:valid ~ *{display:none !important;}}@media (min-width:770px){:root{--sidebar-width:clamp(12.5rem, 28vw, 22rem);}nav{position:fixed;overflow:auto;height:100vh;width:var(--sidebar-width);}main, header{padding:3rem 2rem 3rem calc(var(--sidebar-width) + 3rem);width:calc(54rem + var(--sidebar-width));max-width:100%;}header + main{margin-top:-4rem;}#navtoggle{display:none;}}#togglestate{position:absolute;height:0;opacity:0;}nav.pdoc{--pad:clamp(0.5rem, 2vw, 1.75rem);--indent:1.5rem;background-color:var(--accent);border-right:1px solid var(--accent2);box-shadow:0 0 20px rgba(50, 50, 50, .2) inset;padding:0 0 0 var(--pad);overflow-wrap:anywhere;scrollbar-width:thin; scrollbar-color:var(--accent2) transparent; z-index:1}nav.pdoc::-webkit-scrollbar{width:.4rem; }nav.pdoc::-webkit-scrollbar-thumb{background-color:var(--accent2); }nav.pdoc > div{padding:var(--pad) 0;}nav.pdoc .module-list-button{display:inline-flex;align-items:center;color:var(--text);border-color:var(--muted);margin-bottom:1rem;}nav.pdoc .module-list-button:hover{border-color:var(--text);}nav.pdoc input[type=search]{display:block;outline-offset:0;width:calc(100% - var(--pad));}nav.pdoc .logo{max-width:calc(100% - var(--pad));max-height:35vh;display:block;margin:0 auto 1rem;transform:translate(calc(-.5 * var(--pad)), 0);}nav.pdoc ul{list-style:none;padding-left:0;}nav.pdoc > div > ul{margin-left:calc(0px - var(--pad));}nav.pdoc li a{padding:.2rem 0 .2rem calc(var(--pad) + var(--indent));}nav.pdoc > div > ul > li > a{padding-left:var(--pad);}nav.pdoc li{transition:all 100ms;}nav.pdoc li:hover{background-color:var(--nav-hover);}nav.pdoc a, nav.pdoc a:hover{color:var(--text);}nav.pdoc a{display:block;}nav.pdoc > h2:first-of-type{margin-top:1.5rem;}nav.pdoc .class:before{content:"class ";color:var(--muted);}nav.pdoc .function:after{content:"()";color:var(--muted);}nav.pdoc footer:before{content:"";display:block;width:calc(100% - var(--pad));border-top:solid var(--accent2) 1px;margin-top:1.5rem;padding-top:.5rem;}nav.pdoc footer{font-size:small;}</style>
<style>/*! content.css */.pdoc{color:var(--text);box-sizing:border-box;line-height:1.5;background:none;}.pdoc .pdoc-button{cursor:pointer;display:inline-block;border:solid black 1px;border-radius:2px;font-size:.75rem;padding:calc(0.5em - 1px) 1em;transition:100ms all;}.pdoc .alert{padding:1rem 1rem 1rem calc(1.5rem + 24px);border:1px solid transparent;border-radius:.25rem;background-repeat:no-repeat;background-position:.75rem center;margin-bottom:1rem;}.pdoc .alert > em{display:none;}.pdoc .alert > *:last-child{margin-bottom:0;}.pdoc .alert.note {color:#084298;background-color:#cfe2ff;border-color:#b6d4fe;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23084298%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8%2016A8%208%200%201%200%208%200a8%208%200%200%200%200%2016zm.93-9.412-1%204.705c-.07.34.029.533.304.533.194%200%20.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703%200-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381%202.29-.287zM8%205.5a1%201%200%201%201%200-2%201%201%200%200%201%200%202z%22/%3E%3C/svg%3E");}.pdoc .alert.warning{color:#664d03;background-color:#fff3cd;border-color:#ffecb5;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23664d03%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M8.982%201.566a1.13%201.13%200%200%200-1.96%200L.165%2013.233c-.457.778.091%201.767.98%201.767h13.713c.889%200%201.438-.99.98-1.767L8.982%201.566zM8%205c.535%200%20.954.462.9.995l-.35%203.507a.552.552%200%200%201-1.1%200L7.1%205.995A.905.905%200%200%201%208%205zm.002%206a1%201%200%201%201%200%202%201%201%200%200%201%200-2z%22/%3E%3C/svg%3E");}.pdoc .alert.danger{color:#842029;background-color:#f8d7da;border-color:#f5c2c7;background-image:url("data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20width%3D%2224%22%20height%3D%2224%22%20fill%3D%22%23842029%22%20viewBox%3D%220%200%2016%2016%22%3E%3Cpath%20d%3D%22M5.52.359A.5.5%200%200%201%206%200h4a.5.5%200%200%201%20.474.658L8.694%206H12.5a.5.5%200%200%201%20.395.807l-7%209a.5.5%200%200%201-.873-.454L6.823%209.5H3.5a.5.5%200%200%201-.48-.641l2.5-8.5z%22/%3E%3C/svg%3E");}.pdoc .visually-hidden{position:absolute !important;width:1px !important;height:1px !important;padding:0 !important;margin:-1px !important;overflow:hidden !important;clip:rect(0, 0, 0, 0) !important;white-space:nowrap !important;border:0 !important;}.pdoc h1, .pdoc h2, .pdoc h3{font-weight:300;margin:.3em 0;padding:.2em 0;}.pdoc > section:not(.module-info) h1{font-size:1.5rem;font-weight:500;}.pdoc > section:not(.module-info) h2{font-size:1.4rem;font-weight:500;}.pdoc > section:not(.module-info) h3{font-size:1.3rem;font-weight:500;}.pdoc > section:not(.module-info) h4{font-size:1.2rem;}.pdoc > section:not(.module-info) h5{font-size:1.1rem;}.pdoc a{text-decoration:none;color:var(--link);}.pdoc a:hover{color:var(--link-hover);}.pdoc blockquote{margin-left:2rem;}.pdoc pre{border-top:1px solid var(--accent2);border-bottom:1px solid var(--accent2);margin-top:0;margin-bottom:1em;padding:.5rem 0 .5rem .5rem;overflow-x:auto;background-color:var(--code);}.pdoc code{color:var(--text);padding:.2em .4em;margin:0;font-size:85%;background-color:var(--accent);border-radius:6px;}.pdoc a > code{color:inherit;}.pdoc pre > code{display:inline-block;font-size:inherit;background:none;border:none;padding:0;}.pdoc > section:not(.module-info){margin-bottom:1.5rem;}.pdoc .modulename{margin-top:0;font-weight:bold;}.pdoc .modulename a{color:var(--link);transition:100ms all;}.pdoc .git-button{float:right;border:solid var(--link) 1px;}.pdoc .git-button:hover{background-color:var(--link);color:var(--pdoc-background);}.view-source-toggle-state,.view-source-toggle-state ~ .pdoc-code{display:none;}.view-source-toggle-state:checked ~ .pdoc-code{display:block;}.view-source-button{display:inline-block;float:right;font-size:.75rem;line-height:1.5rem;color:var(--muted);padding:0 .4rem 0 1.3rem;cursor:pointer;text-indent:-2px;}.view-source-button > span{visibility:hidden;}.module-info .view-source-button{float:none;display:flex;justify-content:flex-end;margin:-1.2rem .4rem -.2rem 0;}.view-source-button::before{position:absolute;content:"View Source";display:list-item;list-style-type:disclosure-closed;}.view-source-toggle-state:checked ~ .attr .view-source-button::before,.view-source-toggle-state:checked ~ .view-source-button::before{list-style-type:disclosure-open;}.pdoc .docstring{margin-bottom:1.5rem;}.pdoc section:not(.module-info) .docstring{margin-left:clamp(0rem, 5vw - 2rem, 1rem);}.pdoc .docstring .pdoc-code{margin-left:1em;margin-right:1em;}.pdoc h1:target,.pdoc h2:target,.pdoc h3:target,.pdoc h4:target,.pdoc h5:target,.pdoc h6:target,.pdoc .pdoc-code > pre > span:target{background-color:var(--active);box-shadow:-1rem 0 0 0 var(--active);}.pdoc .pdoc-code > pre > span:target{display:block;}.pdoc div:target > .attr,.pdoc section:target > .attr,.pdoc dd:target > a{background-color:var(--active);}.pdoc *{scroll-margin:2rem;}.pdoc .pdoc-code .linenos{user-select:none;}.pdoc .attr:hover{filter:contrast(0.95);}.pdoc section, .pdoc .classattr{position:relative;}.pdoc .headerlink{--width:clamp(1rem, 3vw, 2rem);position:absolute;top:0;left:calc(0rem - var(--width));transition:all 100ms ease-in-out;opacity:0;}.pdoc .headerlink::before{content:"#";display:block;text-align:center;width:var(--width);height:2.3rem;line-height:2.3rem;font-size:1.5rem;}.pdoc .attr:hover ~ .headerlink,.pdoc *:target > .headerlink,.pdoc .headerlink:hover{opacity:1;}.pdoc .attr{display:block;margin:.5rem 0 .5rem;padding:.4rem .4rem .4rem 1rem;background-color:var(--accent);overflow-x:auto;}.pdoc .classattr{margin-left:2rem;}.pdoc .decorator-deprecated{color:#842029;}.pdoc .decorator-deprecated ~ span{filter:grayscale(1) opacity(0.8);}.pdoc .name{color:var(--name);font-weight:bold;}.pdoc .def{color:var(--def);font-weight:bold;}.pdoc .signature{background-color:transparent;}.pdoc .param, .pdoc .return-annotation{white-space:pre;}.pdoc .signature.multiline .param{display:block;}.pdoc .signature.condensed .param{display:inline-block;}.pdoc .annotation{color:var(--annotation);}.pdoc .view-value-toggle-state,.pdoc .view-value-toggle-state ~ .default_value{display:none;}.pdoc .view-value-toggle-state:checked ~ .default_value{display:inherit;}.pdoc .view-value-button{font-size:.5rem;vertical-align:middle;border-style:dashed;margin-top:-0.1rem;}.pdoc .view-value-button:hover{background:white;}.pdoc .view-value-button::before{content:"show";text-align:center;width:2.2em;display:inline-block;}.pdoc .view-value-toggle-state:checked ~ .view-value-button::before{content:"hide";}.pdoc .inherited{margin-left:2rem;}.pdoc .inherited dt{font-weight:700;}.pdoc .inherited dt, .pdoc .inherited dd{display:inline;margin-left:0;margin-bottom:.5rem;}.pdoc .inherited dd:not(:last-child):after{content:", ";}.pdoc .inherited .class:before{content:"class ";}.pdoc .inherited .function a:after{content:"()";}.pdoc .search-result .docstring{overflow:auto;max-height:25vh;}.pdoc .search-result.focused > .attr{background-color:var(--active);}.pdoc .attribution{margin-top:2rem;display:block;opacity:0.5;transition:all 200ms;filter:grayscale(100%);}.pdoc .attribution:hover{opacity:1;filter:grayscale(0%);}.pdoc .attribution img{margin-left:5px;height:35px;vertical-align:middle;width:70px;transition:all 200ms;}.pdoc table{display:block;width:max-content;max-width:100%;overflow:auto;margin-bottom:1rem;}.pdoc table th{font-weight:600;}.pdoc table th, .pdoc table td{padding:6px 13px;border:1px solid var(--accent2);}</style>
<style>/*! custom.css */</style><script>
window.MathJax = {
tex: {
inlineMath: [['$', '$'], ['\\(', '\\)']]
}
};
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script>
/* Re-invoke MathJax when DOM content changes, for example during search. */
document.addEventListener("DOMContentLoaded", () => {
new MutationObserver(() => MathJax.typeset()).observe(
document.querySelector("main.pdoc").parentNode,
{childList: true}
);
})
</script>
<style>
mjx-container {
overflow-x: auto;
overflow-y: hidden;
}
</style></head>
<body>
<nav class="pdoc">
<label id="navtoggle" for="togglestate" class="pdoc-button"><svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 30 30'><path stroke-linecap='round' stroke="currentColor" stroke-miterlimit='10' stroke-width='2' d='M4 7h22M4 15h22M4 23h22'/></svg></label>
<input id="togglestate" type="checkbox" aria-hidden="true" tabindex="-1">
<div>
<h2>API Documentation</h2>
<ul class="memberlist">
<li>
<a class="function" href="#test_stars">test_stars</a>
</li>
<li>
<a class="function" href="#test_math_newline">test_math_newline</a>
</li>
<li>
<a class="function" href="#test_markdown_newline">test_markdown_newline</a>
</li>
<li>
<a class="function" href="#test_macros">test_macros</a>
</li>
</ul>
<a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
built with <span class="visually-hidden">pdoc</span><img
alt="pdoc logo"
src="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20role%3D%22img%22%20aria-label%3D%22pdoc%20logo%22%20width%3D%22300%22%20height%3D%22150%22%20viewBox%3D%22-1%200%2060%2030%22%3E%3Ctitle%3Epdoc%3C/title%3E%3Cpath%20d%3D%22M29.621%2021.293c-.011-.273-.214-.475-.511-.481a.5.5%200%200%200-.489.503l-.044%201.393c-.097.551-.695%201.215-1.566%201.704-.577.428-1.306.486-2.193.182-1.426-.617-2.467-1.654-3.304-2.487l-.173-.172a3.43%203.43%200%200%200-.365-.306.49.49%200%200%200-.286-.196c-1.718-1.06-4.931-1.47-7.353.191l-.219.15c-1.707%201.187-3.413%202.131-4.328%201.03-.02-.027-.49-.685-.141-1.763.233-.721.546-2.408.772-4.076.042-.09.067-.187.046-.288.166-1.347.277-2.625.241-3.351%201.378-1.008%202.271-2.586%202.271-4.362%200-.976-.272-1.935-.788-2.774-.057-.094-.122-.18-.184-.268.033-.167.052-.339.052-.516%200-1.477-1.202-2.679-2.679-2.679-.791%200-1.496.352-1.987.9a6.3%206.3%200%200%200-1.001.029c-.492-.564-1.207-.929-2.012-.929-1.477%200-2.679%201.202-2.679%202.679A2.65%202.65%200%200%200%20.97%206.554c-.383.747-.595%201.572-.595%202.41%200%202.311%201.507%204.29%203.635%205.107-.037.699-.147%202.27-.423%203.294l-.137.461c-.622%202.042-2.515%208.257%201.727%2010.643%201.614.908%203.06%201.248%204.317%201.248%202.665%200%204.492-1.524%205.322-2.401%201.476-1.559%202.886-1.854%206.491.82%201.877%201.393%203.514%201.753%204.861%201.068%202.223-1.713%202.811-3.867%203.399-6.374.077-.846.056-1.469.054-1.537zm-4.835%204.313c-.054.305-.156.586-.242.629-.034-.007-.131-.022-.307-.157-.145-.111-.314-.478-.456-.908.221.121.432.25.675.355.115.039.219.051.33.081zm-2.251-1.238c-.05.33-.158.648-.252.694-.022.001-.125-.018-.307-.157-.217-.166-.488-.906-.639-1.573.358.344.754.693%201.198%201.036zm-3.887-2.337c-.006-.116-.018-.231-.041-.342.635.145%201.189.368%201.599.625.097.231.166.481.174.642-.03.049-.055.101-.067.158-.046.013-.128.026-.298.004-.278-.037-.901-.57-1.367-1.087zm-1.127-.497c.116.306.176.625.12.71-.019.014-.117.045-.345.016-.206-.027-.604-.332-.986-.695.41-.051.816-.056%201.211-.031zm-4.535%201.535c.209.22.379.47.358.598-.006.041-.088.138-.351.234-.144.055-.539-.063-.979-.259a11.66%2011.66%200%200%200%20.972-.573zm.983-.664c.359-.237.738-.418%201.126-.554.25.237.479.548.457.694-.006.042-.087.138-.351.235-.174.064-.694-.105-1.232-.375zm-3.381%201.794c-.022.145-.061.29-.149.401-.133.166-.358.248-.69.251h-.002c-.133%200-.306-.26-.45-.621.417.091.854.07%201.291-.031zm-2.066-8.077a4.78%204.78%200%200%201-.775-.584c.172-.115.505-.254.88-.378l-.105.962zm-.331%202.302a10.32%2010.32%200%200%201-.828-.502c.202-.143.576-.328.984-.49l-.156.992zm-.45%202.157l-.701-.403c.214-.115.536-.249.891-.376a11.57%2011.57%200%200%201-.19.779zm-.181%201.716c.064.398.194.702.298.893-.194-.051-.435-.162-.736-.398.061-.119.224-.3.438-.495zM8.87%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zm-.735-.389a1.15%201.15%200%200%200-.314.783%201.16%201.16%200%200%200%201.162%201.162c.457%200%20.842-.27%201.032-.653.026.117.042.238.042.362a1.68%201.68%200%200%201-1.679%201.679%201.68%201.68%200%200%201-1.679-1.679c0-.843.626-1.535%201.436-1.654zM5.059%205.406A1.68%201.68%200%200%201%203.38%207.085a1.68%201.68%200%200%201-1.679-1.679c0-.037.009-.072.011-.109.21.3.541.508.935.508a1.16%201.16%200%200%200%201.162-1.162%201.14%201.14%200%200%200-.474-.912c.015%200%20.03-.005.045-.005.926.001%201.679.754%201.679%201.68zM3.198%204.141c0%20.152-.123.276-.276.276s-.275-.124-.275-.276.123-.276.276-.276.275.124.275.276zM1.375%208.964c0-.52.103-1.035.288-1.52.466.394%201.06.64%201.717.64%201.144%200%202.116-.725%202.499-1.738.383%201.012%201.355%201.738%202.499%201.738.867%200%201.631-.421%202.121-1.062.307.605.478%201.267.478%201.942%200%202.486-2.153%204.51-4.801%204.51s-4.801-2.023-4.801-4.51zm24.342%2019.349c-.985.498-2.267.168-3.813-.979-3.073-2.281-5.453-3.199-7.813-.705-1.315%201.391-4.163%203.365-8.423.97-3.174-1.786-2.239-6.266-1.261-9.479l.146-.492c.276-1.02.395-2.457.444-3.268a6.11%206.11%200%200%200%201.18.115%206.01%206.01%200%200%200%202.536-.562l-.006.175c-.802.215-1.848.612-2.021%201.25-.079.295.021.601.274.837.219.203.415.364.598.501-.667.304-1.243.698-1.311%201.179-.02.144-.022.507.393.787.213.144.395.26.564.365-1.285.521-1.361.96-1.381%201.126-.018.142-.011.496.427.746l.854.489c-.473.389-.971.914-.999%201.429-.018.278.095.532.316.713.675.556%201.231.721%201.653.721.059%200%20.104-.014.158-.02.207.707.641%201.64%201.513%201.64h.013c.8-.008%201.236-.345%201.462-.626.173-.216.268-.457.325-.692.424.195.93.374%201.372.374.151%200%20.294-.021.423-.068.732-.27.944-.704.993-1.021.009-.061.003-.119.002-.179.266.086.538.147.789.147.15%200%20.294-.021.423-.069.542-.2.797-.489.914-.754.237.147.478.258.704.288.106.014.205.021.296.021.356%200%20.595-.101.767-.229.438.435%201.094.992%201.656%201.067.106.014.205.021.296.021a1.56%201.56%200%200%200%20.323-.035c.17.575.453%201.289.866%201.605.358.273.665.362.914.362a.99.99%200%200%200%20.421-.093%201.03%201.03%200%200%200%20.245-.164c.168.428.39.846.68%201.068.358.273.665.362.913.362a.99.99%200%200%200%20.421-.093c.317-.148.512-.448.639-.762.251.157.495.257.726.257.127%200%20.25-.024.37-.071.427-.17.706-.617.841-1.314.022-.015.047-.022.068-.038.067-.051.133-.104.196-.159-.443%201.486-1.107%202.761-2.086%203.257zM8.66%209.925a.5.5%200%201%200-1%200c0%20.653-.818%201.205-1.787%201.205s-1.787-.552-1.787-1.205a.5.5%200%201%200-1%200c0%201.216%201.25%202.205%202.787%202.205s2.787-.989%202.787-2.205zm4.4%2015.965l-.208.097c-2.661%201.258-4.708%201.436-6.086.527-1.542-1.017-1.88-3.19-1.844-4.198a.4.4%200%200%200-.385-.414c-.242-.029-.406.164-.414.385-.046%201.249.367%203.686%202.202%204.896.708.467%201.547.7%202.51.7%201.248%200%202.706-.392%204.362-1.174l.185-.086a.4.4%200%200%200%20.205-.527c-.089-.204-.326-.291-.527-.206zM9.547%202.292c.093.077.205.114.317.114a.5.5%200%200%200%20.318-.886L8.817.397a.5.5%200%200%200-.703.068.5.5%200%200%200%20.069.703l1.364%201.124zm-7.661-.065c.086%200%20.173-.022.253-.068l1.523-.893a.5.5%200%200%200-.506-.863l-1.523.892a.5.5%200%200%200-.179.685c.094.158.261.247.432.247z%22%20transform%3D%22matrix%28-1%200%200%201%2058%200%29%22%20fill%3D%22%233bb300%22/%3E%3Cpath%20d%3D%22M.3%2021.86V10.18q0-.46.02-.68.04-.22.18-.5.28-.54%201.34-.54%201.06%200%201.42.28.38.26.44.78.76-1.04%202.38-1.04%201.64%200%203.1%201.54%201.46%201.54%201.46%203.58%200%202.04-1.46%203.58-1.44%201.54-3.08%201.54-1.64%200-2.38-.92v4.04q0%20.46-.04.68-.02.22-.18.5-.14.3-.5.42-.36.12-.98.12-.62%200-1-.12-.36-.12-.52-.4-.14-.28-.18-.5-.02-.22-.02-.68zm3.96-9.42q-.46.54-.46%201.18%200%20.64.46%201.18.48.52%201.2.52.74%200%201.24-.52.52-.52.52-1.18%200-.66-.48-1.18-.48-.54-1.26-.54-.76%200-1.22.54zm14.741-8.36q.16-.3.54-.42.38-.12%201-.12.64%200%201.02.12.38.12.52.42.16.3.18.54.04.22.04.68v11.94q0%20.46-.04.7-.02.22-.18.5-.3.54-1.7.54-1.38%200-1.54-.98-.84.96-2.34.96-1.8%200-3.28-1.56-1.48-1.58-1.48-3.66%200-2.1%201.48-3.68%201.5-1.58%203.28-1.58%201.48%200%202.3%201v-4.2q0-.46.02-.68.04-.24.18-.52zm-3.24%2010.86q.52.54%201.26.54.74%200%201.22-.54.5-.54.5-1.18%200-.66-.48-1.22-.46-.56-1.26-.56-.8%200-1.28.56-.48.54-.48%201.2%200%20.66.52%201.2zm7.833-1.2q0-2.4%201.68-3.96%201.68-1.56%203.84-1.56%202.16%200%203.82%201.56%201.66%201.54%201.66%203.94%200%201.66-.86%202.96-.86%201.28-2.1%201.9-1.22.6-2.54.6-1.32%200-2.56-.64-1.24-.66-2.1-1.92-.84-1.28-.84-2.88zm4.18%201.44q.64.48%201.3.48.66%200%201.32-.5.66-.5.66-1.48%200-.98-.62-1.46-.62-.48-1.34-.48-.72%200-1.34.5-.62.5-.62%201.48%200%20.96.64%201.46zm11.412-1.44q0%20.84.56%201.32.56.46%201.18.46.64%200%201.18-.36.56-.38.9-.38.6%200%201.46%201.06.46.58.46%201.04%200%20.76-1.1%201.42-1.14.8-2.8.8-1.86%200-3.58-1.34-.82-.64-1.34-1.7-.52-1.08-.52-2.36%200-1.3.52-2.34.52-1.06%201.34-1.7%201.66-1.32%203.54-1.32.76%200%201.48.22.72.2%201.06.4l.32.2q.36.24.56.38.52.4.52.92%200%20.5-.42%201.14-.72%201.1-1.38%201.1-.38%200-1.08-.44-.36-.34-1.04-.34-.66%200-1.24.48-.58.48-.58%201.34z%22%20fill%3D%22green%22/%3E%3C/svg%3E"/>
</a>
</div>
</nav>
<main class="pdoc">
<section class="module-info">
<h1 class="modulename">
math_misc </h1>
<div class="docstring"><p>Markdown should ignore tokens within inline <code>$...$</code> and displaymath <code>$$...$$</code>.
<a href="https://github.com/mitmproxy/pdoc/issues/639">https://github.com/mitmproxy/pdoc/issues/639</a></p>
</div>
<input id="mod-math_misc-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<label class="view-source-button" for="mod-math_misc-view-source"><span>View Source</span></label>
<div class="pdoc-code codehilite"><pre><span></span><span id="L-1"><a href="#L-1"><span class="linenos"> 1</span></a><span class="sd">"""</span>
</span><span id="L-2"><a href="#L-2"><span class="linenos"> 2</span></a><span class="sd">Markdown should ignore tokens within inline `$...$` and displaymath `$$...$$`.</span>
</span><span id="L-3"><a href="#L-3"><span class="linenos"> 3</span></a><span class="sd">https://github.com/mitmproxy/pdoc/issues/639</span>
</span><span id="L-4"><a href="#L-4"><span class="linenos"> 4</span></a><span class="sd">"""</span>
</span><span id="L-5"><a href="#L-5"><span class="linenos"> 5</span></a>
</span><span id="L-6"><a href="#L-6"><span class="linenos"> 6</span></a>
</span><span id="L-7"><a href="#L-7"><span class="linenos"> 7</span></a><span class="k">def</span> <span class="nf">test_stars</span><span class="p">():</span>
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a><span class="sd"> Markdown emphasis tokens (`*`) should not be captured in math mode.</span>
</span><span id="L-10"><a href="#L-10"><span class="linenos">10</span></a>
</span><span id="L-11"><a href="#L-11"><span class="linenos">11</span></a><span class="sd"> Currently broken: $*xyz*$</span>
</span><span id="L-12"><a href="#L-12"><span class="linenos">12</span></a>
</span><span id="L-13"><a href="#L-13"><span class="linenos">13</span></a><span class="sd"> Workaround (escaping `*`): $\*xyz\*$</span>
</span><span id="L-14"><a href="#L-14"><span class="linenos">14</span></a>
</span><span id="L-15"><a href="#L-15"><span class="linenos">15</span></a><span class="sd"> Workaround (extra whitespace): $* xyz *$</span>
</span><span id="L-16"><a href="#L-16"><span class="linenos">16</span></a>
</span><span id="L-17"><a href="#L-17"><span class="linenos">17</span></a><span class="sd"> """</span>
</span><span id="L-18"><a href="#L-18"><span class="linenos">18</span></a>
</span><span id="L-19"><a href="#L-19"><span class="linenos">19</span></a>
</span><span id="L-20"><a href="#L-20"><span class="linenos">20</span></a><span class="k">def</span> <span class="nf">test_math_newline</span><span class="p">():</span>
</span><span id="L-21"><a href="#L-21"><span class="linenos">21</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="L-22"><a href="#L-22"><span class="linenos">22</span></a><span class="sd"> Markdown should not consume double backslashes (math newlines) in math mode.</span>
</span><span id="L-23"><a href="#L-23"><span class="linenos">23</span></a>
</span><span id="L-24"><a href="#L-24"><span class="linenos">24</span></a><span class="sd"> Currently broken:</span>
</span><span id="L-25"><a href="#L-25"><span class="linenos">25</span></a>
</span><span id="L-26"><a href="#L-26"><span class="linenos">26</span></a><span class="sd"> $$</span>
</span><span id="L-27"><a href="#L-27"><span class="linenos">27</span></a><span class="sd"> \begin{align\*}</span>
</span><span id="L-28"><a href="#L-28"><span class="linenos">28</span></a><span class="sd"> f(x) &= x^2\\</span>
</span><span id="L-29"><a href="#L-29"><span class="linenos">29</span></a><span class="sd"> &= x \cdot x</span>
</span><span id="L-30"><a href="#L-30"><span class="linenos">30</span></a><span class="sd"> \end{align\*}</span>
</span><span id="L-31"><a href="#L-31"><span class="linenos">31</span></a><span class="sd"> $$</span>
</span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a>
</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a><span class="sd"> Workaround (escaping `\\`):</span>
</span><span id="L-34"><a href="#L-34"><span class="linenos">34</span></a>
</span><span id="L-35"><a href="#L-35"><span class="linenos">35</span></a><span class="sd"> $$</span>
</span><span id="L-36"><a href="#L-36"><span class="linenos">36</span></a><span class="sd"> \begin{align\*}</span>
</span><span id="L-37"><a href="#L-37"><span class="linenos">37</span></a><span class="sd"> f(x) &= x^2\\\\</span>
</span><span id="L-38"><a href="#L-38"><span class="linenos">38</span></a><span class="sd"> &= x \cdot x</span>
</span><span id="L-39"><a href="#L-39"><span class="linenos">39</span></a><span class="sd"> \end{align\*}</span>
</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a><span class="sd"> $$</span>
</span><span id="L-41"><a href="#L-41"><span class="linenos">41</span></a><span class="sd"> """</span>
</span><span id="L-42"><a href="#L-42"><span class="linenos">42</span></a>
</span><span id="L-43"><a href="#L-43"><span class="linenos">43</span></a>
</span><span id="L-44"><a href="#L-44"><span class="linenos">44</span></a><span class="k">def</span> <span class="nf">test_markdown_newline</span><span class="p">():</span>
</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a><span class="sd"> Markdown newlines (`\n\n`) should not emit a paragraph break in math mode.</span>
</span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a>
</span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a><span class="sd"> Currently broken:</span>
</span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a>
</span><span id="L-50"><a href="#L-50"><span class="linenos">50</span></a><span class="sd"> $$</span>
</span><span id="L-51"><a href="#L-51"><span class="linenos">51</span></a><span class="sd"> x + y</span>
</span><span id="L-52"><a href="#L-52"><span class="linenos">52</span></a>
</span><span id="L-53"><a href="#L-53"><span class="linenos">53</span></a><span class="sd"> = z</span>
</span><span id="L-54"><a href="#L-54"><span class="linenos">54</span></a><span class="sd"> $$</span>
</span><span id="L-55"><a href="#L-55"><span class="linenos">55</span></a>
</span><span id="L-56"><a href="#L-56"><span class="linenos">56</span></a><span class="sd"> Workaround (no empty lines in math mode):</span>
</span><span id="L-57"><a href="#L-57"><span class="linenos">57</span></a>
</span><span id="L-58"><a href="#L-58"><span class="linenos">58</span></a><span class="sd"> $$</span>
</span><span id="L-59"><a href="#L-59"><span class="linenos">59</span></a><span class="sd"> x + y</span>
</span><span id="L-60"><a href="#L-60"><span class="linenos">60</span></a><span class="sd"> % comment</span>
</span><span id="L-61"><a href="#L-61"><span class="linenos">61</span></a><span class="sd"> = z</span>
</span><span id="L-62"><a href="#L-62"><span class="linenos">62</span></a><span class="sd"> $$</span>
</span><span id="L-63"><a href="#L-63"><span class="linenos">63</span></a><span class="sd"> """</span>
</span><span id="L-64"><a href="#L-64"><span class="linenos">64</span></a>
</span><span id="L-65"><a href="#L-65"><span class="linenos">65</span></a>
</span><span id="L-66"><a href="#L-66"><span class="linenos">66</span></a><span class="k">def</span> <span class="nf">test_macros</span><span class="p">():</span>
</span><span id="L-67"><a href="#L-67"><span class="linenos">67</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="L-68"><a href="#L-68"><span class="linenos">68</span></a><span class="sd"> Markdown should not capture headings (`#`) in math mode.</span>
</span><span id="L-69"><a href="#L-69"><span class="linenos">69</span></a><span class="sd"> Currently broken:</span>
</span><span id="L-70"><a href="#L-70"><span class="linenos">70</span></a>
</span><span id="L-71"><a href="#L-71"><span class="linenos">71</span></a><span class="sd"> $$</span>
</span><span id="L-72"><a href="#L-72"><span class="linenos">72</span></a><span class="sd"> \newcommand{\define}[2]</span>
</span><span id="L-73"><a href="#L-73"><span class="linenos">73</span></a><span class="sd"> {</span>
</span><span id="L-74"><a href="#L-74"><span class="linenos">74</span></a><span class="sd"> #1 \quad \text{#2}</span>
</span><span id="L-75"><a href="#L-75"><span class="linenos">75</span></a><span class="sd"> }</span>
</span><span id="L-76"><a href="#L-76"><span class="linenos">76</span></a><span class="sd"> \define{e^{i\pi}+1=0}{Euler's identity}</span>
</span><span id="L-77"><a href="#L-77"><span class="linenos">77</span></a><span class="sd"> $$</span>
</span><span id="L-78"><a href="#L-78"><span class="linenos">78</span></a>
</span><span id="L-79"><a href="#L-79"><span class="linenos">79</span></a>
</span><span id="L-80"><a href="#L-80"><span class="linenos">80</span></a><span class="sd"> Workaround (no lines with leading `#`):</span>
</span><span id="L-81"><a href="#L-81"><span class="linenos">81</span></a>
</span><span id="L-82"><a href="#L-82"><span class="linenos">82</span></a><span class="sd"> $$</span>
</span><span id="L-83"><a href="#L-83"><span class="linenos">83</span></a><span class="sd"> \newcommand{\define}[2]{#1 \quad \text{#2}}</span>
</span><span id="L-84"><a href="#L-84"><span class="linenos">84</span></a><span class="sd"> \define{e^{i\pi}+1=0}{Euler's identity}</span>
</span><span id="L-85"><a href="#L-85"><span class="linenos">85</span></a><span class="sd"> $$</span>
</span><span id="L-86"><a href="#L-86"><span class="linenos">86</span></a><span class="sd"> """</span>
</span></pre></div>
</section>
<section id="test_stars">
<input id="test_stars-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">test_stars</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="test_stars-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#test_stars"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="test_stars-8"><a href="#test_stars-8"><span class="linenos"> 8</span></a><span class="k">def</span> <span class="nf">test_stars</span><span class="p">():</span>
</span><span id="test_stars-9"><a href="#test_stars-9"><span class="linenos"> 9</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="test_stars-10"><a href="#test_stars-10"><span class="linenos">10</span></a><span class="sd"> Markdown emphasis tokens (`*`) should not be captured in math mode.</span>
</span><span id="test_stars-11"><a href="#test_stars-11"><span class="linenos">11</span></a>
</span><span id="test_stars-12"><a href="#test_stars-12"><span class="linenos">12</span></a><span class="sd"> Currently broken: $*xyz*$</span>
</span><span id="test_stars-13"><a href="#test_stars-13"><span class="linenos">13</span></a>
</span><span id="test_stars-14"><a href="#test_stars-14"><span class="linenos">14</span></a><span class="sd"> Workaround (escaping `*`): $\*xyz\*$</span>
</span><span id="test_stars-15"><a href="#test_stars-15"><span class="linenos">15</span></a>
</span><span id="test_stars-16"><a href="#test_stars-16"><span class="linenos">16</span></a><span class="sd"> Workaround (extra whitespace): $* xyz *$</span>
</span><span id="test_stars-17"><a href="#test_stars-17"><span class="linenos">17</span></a>
</span><span id="test_stars-18"><a href="#test_stars-18"><span class="linenos">18</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Markdown emphasis tokens (<code>*</code>) should not be captured in math mode.</p>
<p>Currently broken: $<em>xyz</em>$</p>
<p>Workaround (escaping <code>*</code>): $*xyz*$</p>
<p>Workaround (extra whitespace): $* xyz *$</p>
</div>
</section>
<section id="test_math_newline">
<input id="test_math_newline-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">test_math_newline</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="test_math_newline-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#test_math_newline"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="test_math_newline-21"><a href="#test_math_newline-21"><span class="linenos">21</span></a><span class="k">def</span> <span class="nf">test_math_newline</span><span class="p">():</span>
</span><span id="test_math_newline-22"><a href="#test_math_newline-22"><span class="linenos">22</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="test_math_newline-23"><a href="#test_math_newline-23"><span class="linenos">23</span></a><span class="sd"> Markdown should not consume double backslashes (math newlines) in math mode.</span>
</span><span id="test_math_newline-24"><a href="#test_math_newline-24"><span class="linenos">24</span></a>
</span><span id="test_math_newline-25"><a href="#test_math_newline-25"><span class="linenos">25</span></a><span class="sd"> Currently broken:</span>
</span><span id="test_math_newline-26"><a href="#test_math_newline-26"><span class="linenos">26</span></a>
</span><span id="test_math_newline-27"><a href="#test_math_newline-27"><span class="linenos">27</span></a><span class="sd"> $$</span>
</span><span id="test_math_newline-28"><a href="#test_math_newline-28"><span class="linenos">28</span></a><span class="sd"> \begin{align\*}</span>
</span><span id="test_math_newline-29"><a href="#test_math_newline-29"><span class="linenos">29</span></a><span class="sd"> f(x) &= x^2\\</span>
</span><span id="test_math_newline-30"><a href="#test_math_newline-30"><span class="linenos">30</span></a><span class="sd"> &= x \cdot x</span>
</span><span id="test_math_newline-31"><a href="#test_math_newline-31"><span class="linenos">31</span></a><span class="sd"> \end{align\*}</span>
</span><span id="test_math_newline-32"><a href="#test_math_newline-32"><span class="linenos">32</span></a><span class="sd"> $$</span>
</span><span id="test_math_newline-33"><a href="#test_math_newline-33"><span class="linenos">33</span></a>
</span><span id="test_math_newline-34"><a href="#test_math_newline-34"><span class="linenos">34</span></a><span class="sd"> Workaround (escaping `\\`):</span>
</span><span id="test_math_newline-35"><a href="#test_math_newline-35"><span class="linenos">35</span></a>
</span><span id="test_math_newline-36"><a href="#test_math_newline-36"><span class="linenos">36</span></a><span class="sd"> $$</span>
</span><span id="test_math_newline-37"><a href="#test_math_newline-37"><span class="linenos">37</span></a><span class="sd"> \begin{align\*}</span>
</span><span id="test_math_newline-38"><a href="#test_math_newline-38"><span class="linenos">38</span></a><span class="sd"> f(x) &= x^2\\\\</span>
</span><span id="test_math_newline-39"><a href="#test_math_newline-39"><span class="linenos">39</span></a><span class="sd"> &= x \cdot x</span>
</span><span id="test_math_newline-40"><a href="#test_math_newline-40"><span class="linenos">40</span></a><span class="sd"> \end{align\*}</span>
</span><span id="test_math_newline-41"><a href="#test_math_newline-41"><span class="linenos">41</span></a><span class="sd"> $$</span>
</span><span id="test_math_newline-42"><a href="#test_math_newline-42"><span class="linenos">42</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Markdown should not consume double backslashes (math newlines) in math mode.</p>
<p>Currently broken:</p>
<p>$$
\begin{align*}
f(x) &= x^2\
&= x \cdot x
\end{align*}
$$</p>
<p>Workaround (escaping <code>\\</code>):</p>
<p>$$
\begin{align*}
f(x) &= x^2\\
&= x \cdot x
\end{align*}
$$</p>
</div>
</section>
<section id="test_markdown_newline">
<input id="test_markdown_newline-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">test_markdown_newline</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="test_markdown_newline-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#test_markdown_newline"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="test_markdown_newline-45"><a href="#test_markdown_newline-45"><span class="linenos">45</span></a><span class="k">def</span> <span class="nf">test_markdown_newline</span><span class="p">():</span>
</span><span id="test_markdown_newline-46"><a href="#test_markdown_newline-46"><span class="linenos">46</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="test_markdown_newline-47"><a href="#test_markdown_newline-47"><span class="linenos">47</span></a><span class="sd"> Markdown newlines (`\n\n`) should not emit a paragraph break in math mode.</span>
</span><span id="test_markdown_newline-48"><a href="#test_markdown_newline-48"><span class="linenos">48</span></a>
</span><span id="test_markdown_newline-49"><a href="#test_markdown_newline-49"><span class="linenos">49</span></a><span class="sd"> Currently broken:</span>
</span><span id="test_markdown_newline-50"><a href="#test_markdown_newline-50"><span class="linenos">50</span></a>
</span><span id="test_markdown_newline-51"><a href="#test_markdown_newline-51"><span class="linenos">51</span></a><span class="sd"> $$</span>
</span><span id="test_markdown_newline-52"><a href="#test_markdown_newline-52"><span class="linenos">52</span></a><span class="sd"> x + y</span>
</span><span id="test_markdown_newline-53"><a href="#test_markdown_newline-53"><span class="linenos">53</span></a>
</span><span id="test_markdown_newline-54"><a href="#test_markdown_newline-54"><span class="linenos">54</span></a><span class="sd"> = z</span>
</span><span id="test_markdown_newline-55"><a href="#test_markdown_newline-55"><span class="linenos">55</span></a><span class="sd"> $$</span>
</span><span id="test_markdown_newline-56"><a href="#test_markdown_newline-56"><span class="linenos">56</span></a>
</span><span id="test_markdown_newline-57"><a href="#test_markdown_newline-57"><span class="linenos">57</span></a><span class="sd"> Workaround (no empty lines in math mode):</span>
</span><span id="test_markdown_newline-58"><a href="#test_markdown_newline-58"><span class="linenos">58</span></a>
</span><span id="test_markdown_newline-59"><a href="#test_markdown_newline-59"><span class="linenos">59</span></a><span class="sd"> $$</span>
</span><span id="test_markdown_newline-60"><a href="#test_markdown_newline-60"><span class="linenos">60</span></a><span class="sd"> x + y</span>
</span><span id="test_markdown_newline-61"><a href="#test_markdown_newline-61"><span class="linenos">61</span></a><span class="sd"> % comment</span>
</span><span id="test_markdown_newline-62"><a href="#test_markdown_newline-62"><span class="linenos">62</span></a><span class="sd"> = z</span>
</span><span id="test_markdown_newline-63"><a href="#test_markdown_newline-63"><span class="linenos">63</span></a><span class="sd"> $$</span>
</span><span id="test_markdown_newline-64"><a href="#test_markdown_newline-64"><span class="linenos">64</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Markdown newlines (<code>\n\n</code>) should not emit a paragraph break in math mode.</p>
<p>Currently broken:</p>
<p>$$
x + y</p>
<p>= z
$$</p>
<p>Workaround (no empty lines in math mode):</p>
<p>$$
x + y
% comment
= z
$$</p>
</div>
</section>
<section id="test_macros">
<input id="test_macros-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
<div class="attr function">
<span class="def">def</span>
<span class="name">test_macros</span><span class="signature pdoc-code condensed">(<span class="return-annotation">):</span></span>
<label class="view-source-button" for="test_macros-view-source"><span>View Source</span></label>
</div>
<a class="headerlink" href="#test_macros"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="test_macros-67"><a href="#test_macros-67"><span class="linenos">67</span></a><span class="k">def</span> <span class="nf">test_macros</span><span class="p">():</span>
</span><span id="test_macros-68"><a href="#test_macros-68"><span class="linenos">68</span></a><span class="w"> </span><span class="sa">r</span><span class="sd">"""</span>
</span><span id="test_macros-69"><a href="#test_macros-69"><span class="linenos">69</span></a><span class="sd"> Markdown should not capture headings (`#`) in math mode.</span>
</span><span id="test_macros-70"><a href="#test_macros-70"><span class="linenos">70</span></a><span class="sd"> Currently broken:</span>
</span><span id="test_macros-71"><a href="#test_macros-71"><span class="linenos">71</span></a>
</span><span id="test_macros-72"><a href="#test_macros-72"><span class="linenos">72</span></a><span class="sd"> $$</span>
</span><span id="test_macros-73"><a href="#test_macros-73"><span class="linenos">73</span></a><span class="sd"> \newcommand{\define}[2]</span>
</span><span id="test_macros-74"><a href="#test_macros-74"><span class="linenos">74</span></a><span class="sd"> {</span>
</span><span id="test_macros-75"><a href="#test_macros-75"><span class="linenos">75</span></a><span class="sd"> #1 \quad \text{#2}</span>
</span><span id="test_macros-76"><a href="#test_macros-76"><span class="linenos">76</span></a><span class="sd"> }</span>
</span><span id="test_macros-77"><a href="#test_macros-77"><span class="linenos">77</span></a><span class="sd"> \define{e^{i\pi}+1=0}{Euler's identity}</span>
</span><span id="test_macros-78"><a href="#test_macros-78"><span class="linenos">78</span></a><span class="sd"> $$</span>
</span><span id="test_macros-79"><a href="#test_macros-79"><span class="linenos">79</span></a>
</span><span id="test_macros-80"><a href="#test_macros-80"><span class="linenos">80</span></a>
</span><span id="test_macros-81"><a href="#test_macros-81"><span class="linenos">81</span></a><span class="sd"> Workaround (no lines with leading `#`):</span>
</span><span id="test_macros-82"><a href="#test_macros-82"><span class="linenos">82</span></a>
</span><span id="test_macros-83"><a href="#test_macros-83"><span class="linenos">83</span></a><span class="sd"> $$</span>
</span><span id="test_macros-84"><a href="#test_macros-84"><span class="linenos">84</span></a><span class="sd"> \newcommand{\define}[2]{#1 \quad \text{#2}}</span>
</span><span id="test_macros-85"><a href="#test_macros-85"><span class="linenos">85</span></a><span class="sd"> \define{e^{i\pi}+1=0}{Euler's identity}</span>
</span><span id="test_macros-86"><a href="#test_macros-86"><span class="linenos">86</span></a><span class="sd"> $$</span>
</span><span id="test_macros-87"><a href="#test_macros-87"><span class="linenos">87</span></a><span class="sd"> """</span>
</span></pre></div>
<div class="docstring"><p>Markdown should not capture headings (<code>#</code>) in math mode.
Currently broken:</p>
<p>$$
\newcommand{\define}[2]
{</p>
<h1 id="1-quad-text2">1 \quad \text{#2}</h1>
<p>}
\define{e^{i\pi}+1=0}{Euler's identity}
$$</p>
<p>Workaround (no lines with leading <code>#</code>):</p>
<p>$$
\newcommand{\define}[2]{#1 \quad \text{#2}}
\define{e^{i\pi}+1=0}{Euler's identity}
$$</p>
</div>
</section>
</main>
</body>
</html>
|
