Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Commit

Permalink
Doc: Fix broken links (#101)
Browse files Browse the repository at this point in the history
  • Loading branch information
rachelcarmena authored Apr 26, 2020
1 parent b42de7d commit 2dc540e
Show file tree
Hide file tree
Showing 17 changed files with 28 additions and 28 deletions.
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/align/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ TypeClass(Align::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Align)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Align.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/AlignLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Align.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/AlignLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/applicative/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,5 +154,5 @@ since they are all subtypes of `Applicative`.

ank_macro_hierarchy(arrow.typeclasses.Applicative)

[applicative_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Applicative.kt
[applicative_law_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/ApplicativeLaws.kt
[applicative_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Applicative.kt
[applicative_law_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/ApplicativeLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/bicrosswalk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ TypeClass(Bicrosswalk::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Bicrosswalk)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Bicrosswalk.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/BicrosswalkLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Bicrosswalk.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/BicrosswalkLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/bifunctor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,5 @@ TypeClass(Bifunctor::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Bifunctor)

[bifunctor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Bifunctor.kt
[bifunctor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/BifunctorLaws.kt
[bifunctor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Bifunctor.kt
[bifunctor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/BifunctorLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/crosswalk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ TypeClass(Crosswalk::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Crosswalk)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Crosswalk.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/CrosswalkLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Crosswalk.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/core/test/laws/CrosswalkLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/functor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,5 +113,5 @@ since they are all subtypes of `Functor`

ank_macro_hierarchy(arrow.typeclasses.Functor)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Functor.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/FunctorLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Functor.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/FunctorLaws.kt
2 changes: 1 addition & 1 deletion arrow-docs/docs/arrow/typeclasses/hash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,4 @@ import arrow.typeclasses.Hash
TypeClass(Hash::class).hierarchyGraph()
```

[hash_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/HashLaws.kt
[hash_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/HashLaws.kt
2 changes: 1 addition & 1 deletion arrow-docs/docs/arrow/typeclasses/intro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ or treat them as an abstraction placeholder for any one type that can implement
The extension functions are scoped within the typeclass so they do not pollute the global namespace!

To assure that a typeclass has been correctly implemented for a type, Arrow provides a test suite called the "laws" per typeclass.
These test suites are available in the module `arrow-tests`.
These test suites are available in the module `arrow-core-test`.

### Typeclasses provided by Arrow

Expand Down
2 changes: 1 addition & 1 deletion arrow-docs/docs/arrow/typeclasses/monad/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,4 +148,4 @@ import arrow.typeclasses.Monad
TypeClass(Monad::class).hierarchyGraph()
```

[monad_law_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/MonadLaws.kt
[monad_law_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/MonadLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/profunctor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,5 +92,5 @@ TypeClass(Profunctor::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Profunctor)

[profunctor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Profunctor.kt
[profunctor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/ProfunctorLaws.kt
[profunctor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Profunctor.kt
[profunctor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/ProfunctorLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/repeat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,5 @@ TypeClass(Repeat::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Repeat)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Repeat.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/RepeatLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Repeat.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/RepeatLaws.kt
2 changes: 1 addition & 1 deletion arrow-docs/docs/arrow/typeclasses/selective/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ import arrow.typeclasses.Selective
TypeClass(Selective::class).hierarchyGraph()
```

[selective_law_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/SelectiveLaws.kt
[selective_law_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/SelectiveLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/semialign/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,5 @@ TypeClass(Semialign::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Semialign)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Semialign.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/SemialignLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Semialign.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/SemialignLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/unalign/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,5 +69,5 @@ TypeClass(Unalign::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Unalign)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Unalign.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/UnalignLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Unalign.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/UnalignLaws.kt
4 changes: 2 additions & 2 deletions arrow-docs/docs/arrow/typeclasses/zip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,5 @@ TypeClass(Zip::class).dtMarkdownList()

ank_macro_hierarchy(arrow.typeclasses.Zip)

[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-core-data/src/main/kotlin/arrow/typeclasses/Zip.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/arrow-test/src/main/kotlin/arrow/test/laws/ZipLaws.kt
[functor_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-data/src/main/kotlin/arrow/typeclasses/Zip.kt
[functor_laws_source]: https://github.com/arrow-kt/arrow-core/blob/master/arrow-core-test/src/main/kotlin/arrow/test/laws/ZipLaws.kt
2 changes: 1 addition & 1 deletion arrow-docs/docs/datatypes/intro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The implementation of `fold()` is a simple `when` that checks whether `this` is

All other functions provided by `Option` are implemented by using `fold()`, making for idiomatic helper functions like `getOrNull`, `getOrElse`, or `map`. These functions work for any value of `A` and `B`. This way, what `Option` does for each individual case of `String`, `Int`, or absence is up to the functions passed by the user.

Feel free to explore the [implementation of `Option`](https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/src/main/kotlin/arrow/core/extensions/option.kt) and [other datatypes](https://github.com/arrow-kt/arrow/tree/master/modules/core/arrow-core-data/src/main/kotlin/arrow/core) to discover their behavior!
Feel free to explore the [implementation of `Option`](https://github.com/arrow-kt/arrow-core/blob/master/arrow-core/src/main/kotlin/arrow/core/extensions/option.kt) and [other datatypes](https://github.com/arrow-kt/arrow-core/tree/master/arrow-core-data/src/main/kotlin/arrow/core) to discover their behavior!

### Datatypes in Arrow

Expand Down
2 changes: 1 addition & 1 deletion arrow-docs/docs/patterns/monads/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ These are called [Monad Comprehensions]({{ '/patterns/monad_comprehensions' | re
### Monad Laws

There are a couple laws that `just` constructor and `flatMap` need to adhere to, so that they produce a Monad with a stable implementation.
These laws are encoded in Arrow as tests you can find in the `arrow-test` module, and are already tested for all instances in the library.
These laws are encoded in Arrow as tests you can find in the `arrow-core-test` module, and are already tested for all instances in the library.

A typical monad tutorial will place a lot of emphasis on the laws, but I find them less important to explain to a beginner. Nonetheless, here they are for the sake of completeness.

Expand Down

0 comments on commit 2dc540e

Please sign in to comment.