correct & add documentation links #4613
Merged
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
rossabaker
previously approved these changes
Jun 8, 2024
| * - type classes that operate on base types (kind `*`), and their implementations for standard library types, | ||
| * are contained in [[cats.kernel `cats.kernel`]], which is a different SBT project. However, they are re-exported from this package. | ||
| * - type classes of kind `F[_, _]`, | ||
| * such as [[cats.arrow.Profunctor `cats.arrow.Profunctor`]] or [[cats.arrow.Arrow `cats.arrow.Arrow`]], |
There was a problem hiding this comment.
Is this duplication so the terms, the second one backticked, so they appear monospaced but still function as links?
There was a problem hiding this comment.
TBH, it isn't documented that this works on entity links. But it does seem to work.
Though I just noticed IntelliJ warning about "Cross tags" on the backticks.
| @@ -26,32 +26,36 @@ import cats.data.Ior | |||
| * The `cats` root package contains all the trait signatures of most Scala type classes. | |||
| * | |||
| * Cats type classes are implemented using the approach from the | |||
| * [[https://ropas.snu.ac.kr/~bruno/papers/TypeClasses.pdf Type classes as objects and implicits]] article. | |||
| * "[[https://i.cs.hku.hk/~bruno/papers/TypeClasses.pdf Type classes as objects and implicits]]" article. | |||
There was a problem hiding this comment.
Confirmed the old one is 404 and this one is correct.
|
https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html#other-formatting-notes
|
danicheg
previously approved these changes
Jun 9, 2024
rossabaker
approved these changes
Jun 10, 2024
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.
No description provided.