Tweak doc warnings - #26855
Conversation
| * def foo[T](...)(using evidence\$1: A[T]): ... | ||
| * | ||
| * The "evidence$" prefix is a convention copied from Scala 2. | ||
| * The "evid\$" prefix is a convention copied from Scala 2. |
There was a problem hiding this comment.
accidental deletion of a few chars?
|
Nice initiative. FWIW surrounding stuff in backticks should also work (either inline with a single one or as a block), it used not to but I fixed a bunch of Scaladoc low hanging fruit recently. |
|
@SolalPirelli thanks, I submitted it just to say I would try to do some cleaning. I'm too sick and groggy at the moment to do real coding, but while attempting to look at a bug, I noticed reams of warnings. I thought I was up to adding backslashes. Some warnings were due to inherited vars now warning! I remember I did add backticks that were missing! in one instance. I have little love for the doc stack, but appreciate that your eclectic bug fixing includes Scaladoc! |
|
Get better soon! Re: fixes and scaladoc, I tried fixing the most egregious bugs that were fixable without rewriting everything; if you're aware of other such problems in any part of the repo, do let me know. (In this case, having the doc of |
|
Is this still a draft? |
|
I'll push my local squash and retweak. |
672a461 to
304d9c8
Compare
|
This PR prefers quoting to escaping, as many usages should be code blocks. Only the but maybe it also helps rendering of doc in an IDE, if anyone does that. I had a colleague who never read generated docs but only in the comfort of their beloved IDE. I will try to start reading docs and also check the battery in the smoke detector. Some doc, such as for local methods, might never be generated but only rendered in an IDE. It might be nice to standardize on certain idioms, such as to describe transformations, in lieu of various synonymous locutions. I did not follow through with that idea. |
| * or if `isGenericTuple` | ||
| * | ||
| * ``` | ||
| * (x$1: (T1, ... Tn) => { |
There was a problem hiding this comment.
| * (x$1: (T1, ... Tn) => { | |
| * (x$1: (T1, ... Tn)) => { |
2 participants
Reduce doc warnings.