Help get this topic noticed by sharing it on Twitter, Facebook, or email.

The Scaladoc Style Guide should be more concise.

Please move explanations for why things are the way they are and any extra right/wrong examples into sidebars or disclosure sections. Something like http://google-styleguide.googlecode.c... though i'd like to see the guide-points on the left and, when possible, a short example of each to the right so the disclosure doesn't have to be expanded to reveal a simple example. If the example can't be short and concise, include it under the disclosure.
1 person likes
this idea
+1
Reply
  • Thanks for the suggestion. Indeed, that'd be useful, we'd be happy to have a reorganization of that sort-- it's understandable that most people would probably want a (very) quick reference, and that added discussion might only add noise. We'll hold on to this suggestion. docs.scala-lang.org is volunteer effort, so, hopefully someone will come along and pick this up.

    Thanks. If interested in helping out, let me know!
  • (some HTML allowed)
    How does this make you feel?
    Add Image
    I'm

    e.g. happy, confident, thankful, excited sad, anxious, confused, frustrated indifferent, undecided, unconcerned kidding, amused, unsure, silly