Docspree Success

By soc

Created 2011-08-31, 19:17

The monthly Scala Docspree[1] is a community-run event set up by developers who are passionate about adding high quality documentation to the Scala ecosystem. Great documentation helps everyone, from beginners just starting to experts looking for quick answers. This enthusiastic and dedicated group gets together every third Saturday of the month for a Docspree. The first one was a great success and if you think some part of Scala documentation needs beefing up then join an upcoming Docspree session. All new comers are heartily welcomed. Simon Ochsenreither tells us more about the first one here[2].

This month’s Scala Docspree held on the August 20th has finished and a dozen participants from all over the world have successfully contributed documentation to the Scala standard library.

This time, participants from Canada, the US, Britain, Germany, Switzerland and Japan focused on documentation for the AnyVal hierarchy (e. g. Int, Long, Double, ...) as well as thoroughly documenting scala.Predef, sys.process and many collection classes, like HashMap, List, Queue, Stream and Vector.

Thanks to everyone participating, writing documentation, reviewing or merging changes, giving useful hints or lending a helping hand on ##scala-docspree during the event: Your help is very much appreciated!

All contributors, of any level of experience with Scala, are welcome to participate:

If you are interested in contributing documentation, you can get further information about the event from the Scala Wiki[1] and can familiarize yourself with ScalaDoc’s syntax[4], tags[5] and the overall workflow[6].

If you don't feel able to write documentation, you can act as a reviewer for documentation that is produced to help ensure the high quality of every contribution.

If you have a class or method which you think needs more documentation, feel free to add it to the Wishlist[7], so we can take your wishes into account.