diff --git a/CHANGELOG.md b/CHANGELOG.md index 3867278c6c..a7d32e0f92 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,17 @@ Bug-fixes Non-backwards compatible changes -------------------------------- +* The notation for `Decidable` relations has been (partially) standardised: thus + - `_≡?_` (at `infix 4`) for `DecidableEquality` + - `_≈?_` (ditto.) for the fieldname of the general `IsDecEquivalence` + + Despite being non-backwards compatible, because a fieldname has changed, the + old notation `_≟_` (which was used for both of the above) has been retained, + but deprecated. This leads to a large amount of (trivial) deprecations, in + addition to the substantive one under `Relation.Binary.Structures`, and in + `Data.{Nat|Fin}.Properties` for the concrete datatypes. These deprecations + are summarised below, but are not each documented for each affected module. + * [issue #2547](https://github.com/agda/agda-stdlib/issues/2547) The names of the *implicit* binders in the following definitions have been rectified to be consistent with the rest of `Relation.Binary.Definitions`: @@ -39,6 +50,7 @@ Non-backwards compatible changes `Algebra.*`, the field name of the basic homomorphism property `homo` in `Algebra.Morphism.Structures.IsMagmaHomomorphism` has been renamed to `∙-homo`. + Minor improvements ------------------ @@ -59,7 +71,7 @@ Deprecated names inj⇒≟ ↦ inj⇒≡? ≟-≡ ↦ ≡?-≡ ≟-≡-refl ↦ ≡?-≡-refl - ≟-≢ ↦ ≡?-≢ + ≟-≢ ↦ ≡?-≢ ``` * In `Data.Integer.GCD`: @@ -96,6 +108,22 @@ Deprecated names ≢-≟-identity ↦ ≢-≡?-identity ``` +* In `Effect.Monad.Partiality`: + ```agda + _≟-Kind_ ↦ _≡?-Kind_ + ``` + +* In `Reflection.AST.AlphaEquality`: + ```agda + ≟⇒α ↦ ≡?⇒α + ``` + +* In `Relation.Binary.PropositionalEquality`: + ```agda + ≡-≟-identity ↦ ≡-≡?-identity + ≢-≟-identity ↦ ≢-≡?-identity + ``` + * In `Relation.Nary`: ```agda ≟-mapₙ ↦ ≡?-mapₙ diff --git a/doc/style-guide.md b/doc/style-guide.md index ec81edbdd5..2714a94d4c 100644 --- a/doc/style-guide.md +++ b/doc/style-guide.md @@ -590,7 +590,7 @@ word within a compound word is capitalized except for the first word. where `R` is the underlying property being asserted to be `Decidable`, moreover typically sharing the same fixity and precedence as `R`: thus - `_≡?_` (at `infix 4`) for `DecidableEquality` - - `_≈?_` (ditto.) for the name of the general `IsDecEquivalence` + - `_≈?_` (ditto.) for the fieldname of the general `IsDecEquivalence` * Any exceptions to these conventions should be flagged on the GitHub `agda-stdlib` issue tracker in the usual way. diff --git a/src/Data/Bool/Properties.agda b/src/Data/Bool/Properties.agda index afb18d81e9..1f3f2464f5 100644 --- a/src/Data/Bool/Properties.agda +++ b/src/Data/Bool/Properties.agda @@ -139,7 +139,7 @@ true ≤? true = yes b≤b ≤-isDecTotalOrder : IsDecTotalOrder _≡_ _≤_ ≤-isDecTotalOrder = record { isTotalOrder = ≤-isTotalOrder - ; _≟_ = _≡?_ + ; _≈?_ = _≡?_ ; _≤?_ = _≤?_ } diff --git a/src/Data/Char/Properties.agda b/src/Data/Char/Properties.agda index 20b5adbedc..1844bfeb7c 100644 --- a/src/Data/Char/Properties.agda +++ b/src/Data/Char/Properties.agda @@ -179,7 +179,7 @@ _≤?_ = Refl.decidable <-cmp ≤-isDecPartialOrder : IsDecPartialOrder _≡_ _≤_ ≤-isDecPartialOrder = record { isPartialOrder = ≤-isPartialOrder - ; _≟_ = _≡?_ + ; _≈?_ = _≡?_ ; _≤?_ = _≤?_ } @@ -245,7 +245,7 @@ x ≈? y = toℕ x ℕ.≡? toℕ y ≈-isDecEquivalence : IsDecEquivalence _≈_ ≈-isDecEquivalence = record { isEquivalence = ≈-isEquivalence - ; _≟_ = _≈?_ + ; _≈?_ = _≈?_ } ≈-decSetoid : DecSetoid _ _ ≈-decSetoid = record diff --git a/src/Data/Fin/Properties.agda b/src/Data/Fin/Properties.agda index e03f36cd04..e511fc492e 100644 --- a/src/Data/Fin/Properties.agda +++ b/src/Data/Fin/Properties.agda @@ -123,7 +123,7 @@ suc x ≡? suc y = map′ (cong suc) suc-injective (x ≡? y) ≡-isDecEquivalence : IsDecEquivalence {A = Fin n} _≡_ ≡-isDecEquivalence = record { isEquivalence = ≡.isEquivalence - ; _≟_ = _≡?_ + ; _≈?_ = _≡?_ } ------------------------------------------------------------------------ @@ -356,7 +356,7 @@ m