Skip to content

Commit

Permalink
[fixes #2175] Documentation misc. typos etc. for RC1 (#2183)
Browse files Browse the repository at this point in the history
* missing comma!

* corrected reference to `README.Design.Decidability`

* typo: capitalisation

* updated `installation-guide`

* added word to `NonZero` section heading

* Run workflows on any PR

* Add merge-group trigger to workflows

---------

Co-authored-by: MatthewDaggitt <[email protected]>
  • Loading branch information
jamesmckinna and MatthewDaggitt authored Nov 1, 2023
1 parent c2f883f commit 2b7fe61
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ Non-backwards compatible changes
and `Codata.Guarded.Stream.Relation.Binary.Pointwise`, the proofs
called `lookup` have been renamed `lookup⁺`.

#### Changes to `Data.(Nat/Integer/Rational)` proofs of `NonZero`/`Positive`/`Negative` to instance arguments
#### Changes to `Data.(Nat/Integer/Rational)` proofs of `NonZero`/`Positive`/`Negative` to use instance arguments

* Many numeric operations in the library require their arguments to be non-zero,
and various proofs require their arguments to be non-zero/positive/negative etc.
Expand Down Expand Up @@ -2761,7 +2761,7 @@ Additions to existing modules
* Added new definitions and proofs to `Data.Nat.Primality`:
```agda
Composite : ℕ → Set
composite? : Decidable composite
composite? : Decidable Composite
composite⇒¬prime : Composite n → ¬ Prime n
¬composite⇒prime : 2 ≤ n → ¬ Composite n → Prime n
prime⇒¬composite : Prime n → ¬ Composite n
Expand Down
2 changes: 1 addition & 1 deletion README.agda
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ module README where
--
-- Authors: Nils Anders Danielsson, Matthew Daggitt, Guillaume Allais
-- with contributions from Andreas Abel, Stevan Andjelkovic,
-- Jean-Philippe Bernardy, Peter Berry, Bradley Hardy Joachim Breitner,
-- Jean-Philippe Bernardy, Peter Berry, Bradley Hardy, Joachim Breitner,
-- Samuel Bronson, Daniel Brown, Jacques Carette, James Chapman,
-- Liang-Ting Chen, Dominique Devriese, Dan Doel, Érdi Gergő,
-- Zack Grannan, Helmut Grohne, Simon Foster, Liyang Hu, Jason Hu,
Expand Down
12 changes: 6 additions & 6 deletions notes/installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,19 @@ Installation instructions

Note: the full story on installing Agda libraries can be found at [readthedocs](http://agda.readthedocs.io/en/latest/tools/package-system.html).

Use version v1.7.2 of the standard library with Agda 2.6.3.
Use version v2.0 of the standard library with Agda 2.6.4.

1. Navigate to a suitable directory `$HERE` (replace appropriately) where
you would like to install the library.

2. Download the tarball of v1.7.2 of the standard library. This can either be
2. Download the tarball of v2.0 of the standard library. This can either be
done manually by visiting the Github repository for the library, or via the
command line as follows:
```
wget -O agda-stdlib.tar https://github.com/agda/agda-stdlib/archive/v1.7.2.tar.gz
wget -O agda-stdlib.tar https://github.com/agda/agda-stdlib/archive/v2.0.tar.gz
```
Note that you can replace `wget` with other popular tools such as `curl` and that
you can replace `1.7.2` with any other version of the library you desire.
you can replace `2.0` with any other version of the library you desire.

3. Extract the standard library from the tarball. Again this can either be
done manually or via the command line as follows:
Expand All @@ -26,7 +26,7 @@ Use version v1.7.2 of the standard library with Agda 2.6.3.
4. [ OPTIONAL ] If using [cabal](https://www.haskell.org/cabal/) then run
the commands to install via cabal:
```
cd agda-stdlib-1.7.2
cd agda-stdlib-2.0
cabal install
```

Expand All @@ -40,7 +40,7 @@ Use version v1.7.2 of the standard library with Agda 2.6.3.
6. Register the standard library with Agda's package system by adding
the following line to `$HOME/.agda/libraries`:
```
$HERE/agda-stdlib-1.7.2/standard-library.agda-lib
$HERE/agda-stdlib-2.0/standard-library.agda-lib
```

Now, the standard library is ready to be used either:
Expand Down
4 changes: 2 additions & 2 deletions src/Relation/Nullary/Decidable/Core.agda
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ private
-- reflects the boolean result. This definition allows the boolean
-- part of the decision procedure to compute independently from the
-- proof. This leads to better computational behaviour when we only care
-- about the result and not the proof. See README.Decidability for
-- further details.
-- about the result and not the proof. See README.Design.Decidability
-- for further details.

infix 2 _because_

Expand Down

0 comments on commit 2b7fe61

Please sign in to comment.