Add link to hierarchy in IO doc and fix grammar error #166
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #166 +/- ##
=========================================
- Coverage 90.11% 89.92% -0.2%
=========================================
Files 47 47
Lines 1002 1002
Branches 78 78
=========================================
- Hits 903 901 -2
- Misses 99 101 +2 |
alexandru
reviewed
Mar 20, 2018
site/src/main/tut/datatypes/io.md
Outdated
| @@ -107,7 +107,7 @@ def fib(n: Int, a: Long = 0, b: Long = 1): IO[Long] = | |||
| } | |||
| ``` | |||
|
|
|||
| `IO` implements all the typeclasses shown in the hierarchy. Therefore | |||
| `IO` implements all the typeclasses shown in the [hierarchy](https://typelevel.org/cats-effect/typeclasses/). Therefore | |||
There was a problem hiding this comment.
This is pretty cool, but personally I prefer relative links. So either:
../typeclasses/
Or (this being Jekyll):
{{ site.base_url }}typeclasses/
(I'm pretty sure this construct must have a shortcut, but I don't know it)
In the docs I actually used the former. If you move the files, the links break, but then again files should not be moved that often ... cool URLs are URLs that don't change 🙂
There was a problem hiding this comment.
I went with the former to be consistent
LukaJCB
approved these changes
Mar 20, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm reading docs and encountered small grammar error in IO section.
I also have suggestion to add link to the hierarchy - it is mentioned but it isn't anywhere near and if someone (like me) starts reading docs from the top they will see it much later.