You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some classes/methods don't have any documentation, eg Producer
Some links to other classes don't work, or are displayed in full length, eg "rx.lang.scala.Observer" instead of just "Observer"
Running sbt doc spits out a lot of warnings.
Some remarks:
The goal is not to ensure stupid regularity like, for instance, the requirement that every method has a @return -- the scaladoc guide says it shouldn't be added if it's just the same as the whole documentation. But rather, it should be helpful for someone reading it ;-)
Using variables, code duplication in the documentation can be avoided.
To avoid duplicate or unnecessary work, this should be the last thing we do before releasing 1.0.
The text was updated successfully, but these errors were encountered:
The scaladoc needs some attention:
sbt doc
spits out a lot of warnings.Some remarks:
@return
-- the scaladoc guide says it shouldn't be added if it's just the same as the whole documentation. But rather, it should be helpful for someone reading it ;-)The text was updated successfully, but these errors were encountered: