Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

correct & add documentation links #4613

Merged
merged 2 commits into from
Jun 10, 2024

Conversation

performantdata
Copy link
Contributor

No description provided.

rossabaker
rossabaker previously approved these changes Jun 8, 2024
Copy link
Member

@rossabaker rossabaker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

* - 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`]],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this duplication so the terms, the second one backticked, so they appear monospaced but still function as links?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

Copy link
Contributor Author

@performantdata performantdata Jun 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed the old one is 404 and this one is correct.

@performantdata
Copy link
Contributor Author

https://docs.scala-lang.org/overviews/scaladoc/for-library-authors.html#other-formatting-notes

List blocks […] you must have extra space in front

danicheg
danicheg previously approved these changes Jun 9, 2024
@performantdata performantdata dismissed stale reviews from danicheg and rossabaker via 531ed53 June 9, 2024 23:47
@rossabaker rossabaker merged commit 1a0d029 into typelevel:main Jun 10, 2024
16 checks passed
@performantdata performantdata deleted the documentation branch June 11, 2024 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants