Skip to content

Commit c6e9229

Browse files
documentation: fix link to installation-guide, README.agda, README.md... (#2197)
* fix link to `installation-guide` * catching another reference to `notes/` * note on instance brackets * `HACKING` guide * added Gurmeet Singh's changes * [ fix ] links in README.md --------- Co-authored-by: Guillaume Allais <[email protected]>
1 parent ff1dc85 commit c6e9229

File tree

4 files changed

+18
-12
lines changed

4 files changed

+18
-12
lines changed

HACKING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Contributing to the library
44
Thank you for your interest in contributing to the Agda standard library.
55
Hopefully this guide should make it easy to do so! Feel free to ask any
66
questions on the Agda mailing list. Before you start please read the
7-
[style-guide](https://github.com/agda/agda-stdlib/blob/master/notes/style-guide.md).
7+
[style-guide](https://github.com/agda/agda-stdlib/blob/master/doc/style-guide.md).
88

99
What is an acceptable contribution?
1010
===================================
@@ -124,7 +124,7 @@ git push USER -u new_feature
124124

125125
You can then proceed to make your changes. Please follow existing
126126
conventions in the library, see
127-
[style-guide](https://github.com/agda/agda-stdlib/blob/master/notes/style-guide.md).
127+
[style-guide](https://github.com/agda/agda-stdlib/blob/master/doc/style-guide.md).
128128
for details. Document your changes in `agda-stdlib-fork/CHANGELOG.md`.
129129

130130
If you are creating new modules, please make sure you are having a

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,19 @@ If you're looking to find your way around the library, there are several
1818
different ways to get started:
1919

2020
- The library's structure and the associated design choices are described
21-
in the [README.agda](https://github.com/agda/agda-stdlib/tree/master/README.agda).
21+
in the [README.agda](https://github.com/agda/agda-stdlib/tree/master/doc/README.agda).
2222

23-
- The [README folder](https://github.com/agda/agda-stdlib/tree/master/README),
23+
- The [README folder](https://github.com/agda/agda-stdlib/tree/master/doc/README),
2424
which mirrors the structure of the main library, contains examples of how to
2525
use some of the more common modules. Feel free to [open a new issue](https://github.com/agda/agda-stdlib/issues/new) if there's a particular module you feel could do with
2626
some more documentation.
2727

28-
- You can [browse the library's source code](https://agda.github.io/agda-stdlib/README.html)
28+
- You can [browse the library's source code](https://agda.github.io/agda-stdlib/)
2929
in glorious clickable HTML.
3030

31-
- Finally, you can get an overview of the entire library by looking at the
32-
[index](https://agda.github.io/agda-stdlib/), which lists all modules
33-
in the library except the deprecated ones.
34-
3531
## Installation instructions
3632

37-
See the [installation instructions](https://github.com/agda/agda-stdlib/blob/master/notes/installation-guide.md) for the latest version of the standard library.
33+
See the [installation instructions](https://github.com/agda/agda-stdlib/blob/master/doc/installation-guide.md) for the latest version of the standard library.
3834

3935
#### Old versions of Agda
4036

doc/release-guide.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ procedure should be followed:
33

44
#### Pre-release changes
55

6-
* Update `README.agda` by replacing 'development version' by 'version X.Y' in the title.
6+
* Update `doc/README.agda` by replacing 'development version' by 'version X.Y' in the title.
77

88
* Update the version to `X.Y` in:
99
- `agda-stdlib-utils.cabal`
1010
- `standard-library.agda-lib`
1111
- `CITATION.cff`
1212
- `CHANGELOG.md`
1313
- `README.md`
14-
- `notes/installation-guide.txt`
14+
- `doc/installation-guide.md`
1515

1616
* Update the copyright year range in the LICENSE file, if necessary.
1717

doc/style-guide.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,16 @@ line of code, indented by two spaces.
333333
... | false = filter p xs
334334
```
335335

336+
* Instance arguments, and their types, should use the vanilla ASCII/UTF-8 `{{_}}`
337+
syntax in preference to the Unicode `⦃_⦄` syntax (written using `\{{`/`\}}`),
338+
which moreover requires additional whitespace to parse correctly.
339+
NB. Even for irrelevant instances, such as typically for `NonZero` arguments,
340+
neverthelesss it is necessary to supply an underscore binding `{{_ : NonZero n}}`
341+
if subsequent terms occurring in the type rely on that argument to be well-formed:
342+
eg in `Data.Nat.DivMod`, in the use of `_/ n` and `_% n`
343+
```agda
344+
m≡m%n+[m/n]*n : ∀ m n .{{_ : NonZero n}} → m ≡ m % n + (m / n) * n
345+
```
336346

337347
## Types
338348

0 commit comments

Comments
 (0)