Skip to content

Commit a3cb079

Browse files
authored
Merge pull request #401 from tweag/tbagrel1/absolute-readme-links
Change relative links for absolute ones in the README
2 parents 9497a82 + 3e60ca2 commit a3cb079

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Change Log
22

3-
## [v0.2.0](https://github.com/tweag/linear-base/tree/v0.2.0) - 2022-03-17
3+
## [v0.2.0](https://github.com/tweag/linear-base/tree/v0.2.0) - 2022-03-25
44

55
[Full Changelog](https://github.com/tweag/linear-base/compare/v0.1.0...v0.2.0)
66

@@ -116,6 +116,7 @@
116116

117117
### Documentation improvements
118118

119+
- Change relative links for absolute ones in the README [\#401](https://github.com/tweag/linear-base/pull/401) ([tbagrel1](https://github.com/tbagrel1))
119120
- Add comparison table between `Prelude` and `Prelude.Linear` classes [\#368](https://github.com/tweag/linear-base/pull/368) ([tbagrel1](https://github.com/tbagrel1))
120121
- Add Hackage and Stackage badges [\#336](https://github.com/tweag/linear-base/pull/336) ([utdemir](https://github.com/utdemir))
121122
- Hide internal modules from `haddock` documentation [\#326](https://github.com/tweag/linear-base/pull/326) ([utdemir](https://github.com/utdemir)), [\#363](https://github.com/tweag/linear-base/pull/363) ([tbagrel1](https://github.com/tbagrel1))

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ the top:
4343

4444
If you already know what `-XLinearTypes` does and what the linear
4545
arrow `a %1-> b` means, then read the [User Guide] and explore the
46-
[`examples/`](./examples) folder to know how to use `linear-base`.
46+
[`examples/`](https://github.com/tweag/linear-base/blob/master/examples) folder to know how to use `linear-base`.
4747

4848
You can also find a table comparing `base` and `linear-base` typeclasses
49-
[here](./docs/CLASS_TABLE.md).
49+
[here](https://github.com/tweag/linear-base/blob/master/docs/CLASS_TABLE.md).
5050

5151
## Learning about `-XLinearTypes`
5252

@@ -55,7 +55,7 @@ There are plenty of excellent resources and examples to help you.
5555

5656
### Tutorials and examples
5757

58-
* See the [`examples/`](./examples) folder.
58+
* See the [`examples/`](https://github.com/tweag/linear-base/blob/master/examples) folder.
5959
* [Linear examples on watertight 3D models](https://github.com/gelisam/linear-examples)
6060

6161
### Reading material
@@ -87,13 +87,13 @@ making pull requests.
8787

8888
## Licence
8989

90-
See the [Licence file](./LICENSE).
90+
See the [Licence file](https://github.com/tweag/linear-base/blob/master/LICENSE).
9191

9292
Copyright © Tweag Holding and its affiliates.
9393

9494
[Tweag]: https://www.tweag.io/
9595
[`base`]: https://hackage.haskell.org/package/base
96-
[User Guide]: ./docs/USER_GUIDE.md
97-
[Design Document]: ./docs/DESIGN.md
96+
[User Guide]: https://github.com/tweag/linear-base/blob/master/docs/USER_GUIDE.md
97+
[Design Document]: https://github.com/tweag/linear-base/blob/master/docs/DESIGN.md
9898
[hackage-pkg]: https://hackage.haskell.org/package/linear-base
9999
[stackage-pkg]: https://www.stackage.org/nightly/package/linear-base

docs/USER_GUIDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ if you are unfamiliar).
2424
library](https://hackage.haskell.org/package/streaming) is in
2525
`Streaming.Linear` and `Streaming.Prelude.Linear`.
2626
* How `Prelude.Linear` classes relate to their `base` (non-linear) counterpart is
27-
described in the [class comparison table](./CLASS_TABLE.md).
27+
described in the [class comparison table](https://github.com/tweag/linear-base/blob/master/docs/CLASS_TABLE.md).
2828

2929
There are many other modules of course but a lot of the ones not already listed
3030
are still experimental, such as system-heap memory management in `Foreign.Marshall.Pure`.
@@ -169,6 +169,6 @@ useSubfunction arr = fromRead (read arr 0)
169169
fromRead = undefined
170170
```
171171

172-
[`Data.Unrestricted`]: ../src/Data/Unrestricted/Linear.hs
173-
[`Prelude.Linear`]: ../src/Prelude/Linear.hs
174-
[`README`]: ../README.md
172+
[`Data.Unrestricted`]: https://github.com/tweag/linear-base/blob/master/src/Data/Unrestricted/Linear.hs
173+
[`Prelude.Linear`]: https://github.com/tweag/linear-base/blob/master/src/Prelude/Linear.hs
174+
[`README`]: https://github.com/tweag/linear-base/blob/master/README.md

0 commit comments

Comments
 (0)