Add grouping to scaladoc for arity methods #2080
Conversation
|
Oops I spotted a typo. Change incoming. |
This makes it so when you look at the `Applicative` scaladoc you don't have a bunch of `ap3`, `ap4`, etc noise mixed in with the more meaningful methods. Instead, the generated higher-arity methods show up in separate scaladoc groups below. To see the changes you can pull this branch, run `sbt unidoc` (you may need to clean first), and open `cats/docs/target/scala-2.12/unidoc/cats/Applicative.html` in your browser.
ceedubs
force-pushed
the
scaladoc-groups
branch
from
586542d
to
f6592e0
Compare
|
Resolves #1113 |
Codecov Report
@@ Coverage Diff @@
## master #2080 +/- ##
=======================================
Coverage 94.66% 94.66%
=======================================
Files 318 318
Lines 5383 5383
Branches 207 207
=======================================
Hits 5096 5096
Misses 287 287Continue to review full report at Codecov.
|
|
It seems that only @kailuowang shares my enthusiasm for this change :P Asking people to pull my branch and generate the scaladoc to check out this change probably had a fairly significant barrier. For anyone who is interested, here are before/after images for part of the scaladocs. Before this PR: After this PR: Higher-arity methods are grouped below the main methods: |
|
@travisbrown or @mpilquist do either of you want to take a look? Circe and Scodec are two of very few projects that I can think of that use Scaladoc groups. |
This makes it so when you look at the
Applicativescaladoc you don'thave a bunch of
ap3,ap4, etc noise mixed in with the moremeaningful methods. Instead, the generated higher-arity methods show up
in separate scaladoc groups below.
To see the changes you can pull this branch, run
sbt unidoc(you mayneed to clean first), and open
cats/docs/target/scala-2.12/unidoc/cats/Applicative.htmlin yourbrowser.