Skip to content

Commit c0ffc85

Browse files
authored
chore: require docs in BitVec (#4913)
1 parent f62359a commit c0ffc85

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

src/Init/Data/BitVec/Basic.lean

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ We define many of the bitvector operations from the
2020
of SMT-LIBv2.
2121
-/
2222

23+
set_option linter.missingDocs true
24+
2325
/--
2426
A bitvector of the specified width.
2527
@@ -34,9 +36,9 @@ structure BitVec (w : Nat) where
3436
O(1), because we use `Fin` as the internal representation of a bitvector. -/
3537
toFin : Fin (2^w)
3638

37-
@[deprecated (since := "2024-04-12")]
38-
protected abbrev Std.BitVec := _root_.BitVec
39-
39+
/--
40+
Bitvectors have decidable equality. This should be used via the instance `DecidableEq (BitVec n)`.
41+
-/
4042
-- We manually derive the `DecidableEq` instances for `BitVec` because
4143
-- we want to have builtin support for bit-vector literals, and we
4244
-- need a name for this function to implement `canUnfoldAtMatcher` at `WHNF.lean`.

src/Init/Data/BitVec/Bitblast.lean

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ https://github.com/mhk119/lean-smt/blob/bitvec/Smt/Data/Bitwise.lean.
2828
2929
-/
3030

31+
set_option linter.missingDocs true
32+
3133
open Nat Bool
3234

3335
namespace Bool

src/Init/Data/BitVec/Folds.lean

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import Init.Data.BitVec.Lemmas
88
import Init.Data.Nat.Lemmas
99
import Init.Data.Fin.Iterate
1010

11+
set_option linter.missingDocs true
12+
1113
namespace BitVec
1214

1315
/--

src/Init/Data/BitVec/Lemmas.lean

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import Init.Data.Nat.Lemmas
1212
import Init.Data.Nat.Mod
1313
import Init.Data.Int.Bitwise.Lemmas
1414

15+
set_option linter.missingDocs true
16+
1517
namespace BitVec
1618

1719
/--

0 commit comments

Comments
 (0)