This page is no longer maintained — Please continue to the home page at www.scala-lang.org

Adding documentation to the Scala library

1 reply
Derek Wyatt 2
Joined: 2011-02-12,
User offline. Last seen 42 years 45 weeks ago.

Hi guys,

I'm not sure 100% sure I'm going to have time for this but if
possible, I'd like to add some documentation to the Scala library's
Scaladoc as I work. Of course, all of my documentation would be free
for Typesafe to consume provided I'm not liable for any garbage I
write :)

What would be required for me to do this? Would I simply fork the
repository and make a pull request some day?

Thanks,
Derek

Seth Tisue
Joined: 2008-12-16,
User offline. Last seen 34 weeks 3 days ago.
Re: Adding documentation to the Scala library

On Tue, Aug 16, 2011 at 8:16 AM, Derek Wyatt wrote:
> I'm not sure 100% sure I'm going to have time for this but if
> possible, I'd like to add some documentation to the Scala library's
> Scaladoc as I work. Of course, all of my documentation would be free
> for Typesafe to consume provided I'm not liable for any garbage I
> write :)
>
> What would be required for me to do this?  Would I simply fork the
> repository and make a pull request some day?

Yes. See instructions here:
https://wiki.scala-lang.org/display/SW/Scalathon+Docspree

Consider also participating in this:
https://wiki.scala-lang.org/display/SW/Monthly+Scala+Docspree

Colladoc is being brought back to make it easier to contribute
Scaladoc, but that's still in process ("final product is expected by
August or September").

Copyright © 2012 École Polytechnique Fédérale de Lausanne (EPFL), Lausanne, Switzerland