Skip to content

Commit d9cff27

Browse files
committed
chore: add a few missing codeblock fences to doc-strings (#39245)
Found by the linter in #27897, but I expect the move to Verso would also have discovered this.
1 parent c2fc74d commit d9cff27

5 files changed

Lines changed: 61 additions & 34 deletions

File tree

Mathlib/Algebra/Lie/Classical.lean

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -238,8 +238,10 @@ theorem soIndefiniteEquiv_apply {i : R} (hi : i * i = -1) (A : so' p q R) :
238238
239239
It looks like this as a `2l x 2l` matrix of `l x l` blocks:
240240
241-
[ 0 1 ]
242-
[ 1 0 ]
241+
```
242+
[ 0 1 ]
243+
[ 1 0 ]
244+
```
243245
-/
244246
def JD : Matrix (l ⊕ l) (l ⊕ l) R :=
245247
Matrix.fromBlocks 0 1 1 0
@@ -254,9 +256,10 @@ diagonal matrix.
254256
255257
It looks like this as a `2l x 2l` matrix of `l x l` blocks:
256258
257-
[ 1 -1 ]
258-
[ 1 1 ]
259-
-/
259+
```
260+
[ 1 -1 ]
261+
[ 1 1 ]
262+
``` -/
260263
def PD : Matrix (l ⊕ l) (l ⊕ l) R :=
261264
Matrix.fromBlocks 1 (-1) 1 1
262265

@@ -295,15 +298,19 @@ noncomputable def typeDEquivSo' [Fintype l] [Invertible (2 : R)] : typeD l R ≃
295298
296299
It looks like this as a `(2l+1) x (2l+1)` matrix of blocks:
297300
298-
[ 2 0 0 ]
299-
[ 0 0 1 ]
300-
[ 0 1 0 ]
301+
```
302+
[ 2 0 0 ]
303+
[ 0 0 1 ]
304+
[ 0 1 0 ]
305+
```
301306
302307
where sizes of the blocks are:
303308
304-
[`1 x 1` `1 x l` `1 x l`]
305-
[`l x 1` `l x l` `l x l`]
306-
[`l x 1` `l x l` `l x l`]
309+
```
310+
[`1 x 1` `1 x l` `1 x l`]
311+
[`l x 1` `l x l` `l x l`]
312+
[`l x 1` `l x l` `l x l`]
313+
```
307314
-/
308315
def JB :=
309316
Matrix.fromBlocks ((2 : R) • (1 : Matrix Unit Unit R)) 0 0 (JD l R)
@@ -318,16 +325,19 @@ almost-split-signature diagonal matrix.
318325
319326
It looks like this as a `(2l+1) x (2l+1)` matrix of blocks:
320327
321-
[ 1 0 0 ]
322-
[ 0 1 -1 ]
323-
[ 0 1 1 ]
328+
```
329+
[ 1 0 0 ]
330+
[ 0 1 -1 ]
331+
[ 0 1 1 ]
332+
```
324333
325334
where sizes of the blocks are:
326335
327-
[`1 x 1` `1 x l` `1 x l`]
328-
[`l x 1` `l x l` `l x l`]
329-
[`l x 1` `l x l` `l x l`]
330-
-/
336+
```
337+
[`1 x 1` `1 x l` `1 x l`]
338+
[`l x 1` `l x l` `l x l`]
339+
[`l x 1` `l x l` `l x l`]
340+
``` -/
331341
def PB :=
332342
Matrix.fromBlocks (1 : Matrix Unit Unit R) 0 0 (PD l R)
333343

Mathlib/Data/List/Defs.lean

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,11 @@ instance instSProd : SProd (List α) (List β) (List (α × β)) where
240240
sprod := List.product
241241

242242
/-- `dedup l` removes duplicates from `l` (taking only the last occurrence).
243-
Defined as `pwFilter (≠)`.
243+
Defined as `pwFilter (≠)`.
244244
245-
dedup [1, 0, 2, 2, 1] = [0, 2, 1] -/
245+
```
246+
dedup [1, 0, 2, 2, 1] = [0, 2, 1]
247+
``` -/
246248
def dedup [DecidableEq α] : List α → List α :=
247249
pwFilter (· ≠ ·)
248250

Mathlib/Data/Num/Basic.lean

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ collection of theorems is to show the equivalence of the different approaches.
2323

2424
/-- The type of positive binary numbers.
2525
26-
13 = 1101(base 2) = bit1 (bit0 (bit1 one)) -/
26+
```
27+
13 = 1101(base 2) = bit1 (bit0 (bit1 one))
28+
``` -/
2729
inductive PosNum : Type
2830
| one : PosNum
2931
| bit1 : PosNum → PosNum
@@ -38,7 +40,9 @@ instance : Inhabited PosNum :=
3840

3941
/-- The type of nonnegative binary numbers, using `PosNum`.
4042
41-
13 = 1101(base 2) = pos (bit1 (bit0 (bit1 one))) -/
43+
```
44+
13 = 1101(base 2) = pos (bit1 (bit0 (bit1 one)))
45+
``` -/
4246
inductive Num : Type
4347
| zero : Num
4448
| pos : PosNum → Num
@@ -55,8 +59,10 @@ instance : Inhabited Num :=
5559

5660
/-- Representation of integers using trichotomy around zero.
5761
58-
13 = 1101(base 2) = pos (bit1 (bit0 (bit1 one)))
59-
-13 = -1101(base 2) = neg (bit1 (bit0 (bit1 one))) -/
62+
```
63+
13 = 1101(base 2) = pos (bit1 (bit0 (bit1 one)))
64+
-13 = -1101(base 2) = neg (bit1 (bit0 (bit1 one)))
65+
``` -/
6066
inductive ZNum : Type
6167
| zero : ZNum
6268
| pos : PosNum → ZNum

Mathlib/Data/Num/Bitwise.lean

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -216,20 +216,25 @@ inductive NzsNum : Type
216216
| bit : Bool → NzsNum → NzsNum
217217
deriving DecidableEq
218218

219-
/-- Alternative representation of integers using a sign bit at the end.
220-
The convention on sign here is to have the argument to `msb` denote
221-
the sign of the MSB itself, with all higher bits set to the negation
222-
of this sign. The result is interpreted in two's complement.
219+
/--
220+
Alternative representation of integers using a sign bit at the end.
221+
The convention on sign here is to have the argument to `msb` denote
222+
the sign of the MSB itself, with all higher bits set to the negation
223+
of this sign. The result is interpreted in two's complement.
223224
224-
13 = ..0001101(base 2) = nz (bit1 (bit0 (bit1 (msb true))))
225-
-13 = ..1110011(base 2) = nz (bit1 (bit1 (bit0 (msb false))))
225+
```
226+
13 = ..0001101(base 2) = nz (bit1 (bit0 (bit1 (msb true))))
227+
-13 = ..1110011(base 2) = nz (bit1 (bit1 (bit0 (msb false))))
228+
```
226229
227230
As with `Num`, a special case must be added for zero, which has no msb,
228-
but by two's complement symmetry there is a second special case for -1.
229-
Here the `Bool` field indicates the sign of the number.
231+
but by two's complement symmetry there is a second special case for -1.
232+
Here the `Bool` field indicates the sign of the number.
230233
231-
0 = ..0000000(base 2) = zero false
232-
-1 = ..1111111(base 2) = zero true -/
234+
```
235+
0 = ..0000000(base 2) = zero false
236+
-1 = ..1111111(base 2) = zero true
237+
``` -/
233238
inductive SNum : Type
234239
| zero : Bool → SNum
235240
| nz : NzsNum → SNum

Mathlib/Geometry/RingedSpace/PresheafedSpace/Gluing.lean

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,10 +489,12 @@ instance ιIsOpenImmersion (i : D.J) : IsOpenImmersion (𝖣.ι i) where
489489
set_option backward.isDefEq.respectTransparency false in
490490
/-- The following diagram is a pullback, i.e. `Vᵢⱼ` is the intersection of `Uᵢ` and `Uⱼ` in `X`.
491491
492+
```
492493
Vᵢⱼ ⟶ Uᵢ
493494
| |
494495
↓ ↓
495496
Uⱼ ⟶ X
497+
```
496498
-/
497499
def vPullbackConeIsLimit (i j : D.J) : IsLimit (𝖣.vPullbackCone i j) :=
498500
PullbackCone.isLimitAux' _ fun s => by
@@ -589,10 +591,12 @@ theorem ι_jointly_surjective (x : 𝖣.glued) : ∃ (i : D.J) (y : D.U i), (
589591

590592
/-- The following diagram is a pullback, i.e. `Vᵢⱼ` is the intersection of `Uᵢ` and `Uⱼ` in `X`.
591593
594+
```
592595
Vᵢⱼ ⟶ Uᵢ
593596
| |
594597
↓ ↓
595598
Uⱼ ⟶ X
599+
```
596600
-/
597601
def vPullbackConeIsLimit (i j : D.J) : IsLimit (𝖣.vPullbackCone i j) :=
598602
𝖣.vPullbackConeIsLimitOfMap forgetToPresheafedSpace i j

0 commit comments

Comments
 (0)