Scala Library Documentation

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

Scala Library Documentation

Eddy WM
Hey fellows scala devs

I'm new to scala world, I have been writing codes for long time in Java, JavaScript and PHP. I have developed several business applications like web apps using both PHP and Java, Android applications, rich client applications ,...
I started last month to learn Scala after having made some inquiries on the language and the community behind the language.
Since I have learning the language I have realised that in the Scala Library the classes are not documented, as a  long time Java developer I used to dig into the jdk , read what the library designers wrote about the jdk classes , methods and fields and I mostly ended up finding the why of many classes and methods just by looking at their codes. 
For me it's just impossible to read the codes in the Scala Library, the codes are condensed and there is nothing like comment in any of the class, I may want to understand the implementation of a given data struture but nothing is given as documentation in the library for someone to understand.

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Scala Library Documentation

Brian Maso
They are pretty well documented. Search for "scaladocs", or look at the official scala-lang site: http://www.scala-lang.org/api/current/scala/index.html

Brian Maso

On Thu, Feb 16, 2017 at 5:11 PM, Eddy WM <[hidden email]> wrote:
Hey fellows scala devs

I'm new to scala world, I have been writing codes for long time in Java, JavaScript and PHP. I have developed several business applications like web apps using both PHP and Java, Android applications, rich client applications ,...
I started last month to learn Scala after having made some inquiries on the language and the community behind the language.
Since I have learning the language I have realised that in the Scala Library the classes are not documented, as a  long time Java developer I used to dig into the jdk , read what the library designers wrote about the jdk classes , methods and fields and I mostly ended up finding the why of many classes and methods just by looking at their codes. 
For me it's just impossible to read the codes in the Scala Library, the codes are condensed and there is nothing like comment in any of the class, I may want to understand the implementation of a given data struture but nothing is given as documentation in the library for someone to understand.

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.



--
Best regards,
Brian Maso
(949) 395-8551
Follow me: @bmaso
[hidden email]

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Scala Library Documentation

Donald McLean-3
Not to burst Brian's bubble, but while there IS documentation, it is incomplete and often useless to someone who doesn't already know Scala quite well.

Examples would really help make many of the API functions understandable.

On Fri, Feb 17, 2017 at 12:01 AM, Brian Maso <[hidden email]> wrote:
They are pretty well documented. Search for "scaladocs", or look at the official scala-lang site: http://www.scala-lang.org/api/current/scala/index.html

Brian Maso

On Thu, Feb 16, 2017 at 5:11 PM, Eddy WM <[hidden email]> wrote:
Hey fellows scala devs

I'm new to scala world, I have been writing codes for long time in Java, JavaScript and PHP. I have developed several business applications like web apps using both PHP and Java, Android applications, rich client applications ,...
I started last month to learn Scala after having made some inquiries on the language and the community behind the language.
Since I have learning the language I have realised that in the Scala Library the classes are not documented, as a  long time Java developer I used to dig into the jdk , read what the library designers wrote about the jdk classes , methods and fields and I mostly ended up finding the why of many classes and methods just by looking at their codes. 
For me it's just impossible to read the codes in the Scala Library, the codes are condensed and there is nothing like comment in any of the class, I may want to understand the implementation of a given data struture but nothing is given as documentation in the library for someone to understand.

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.



--
Best regards,
Brian Maso
<a href="tel:(949)%20395-8551" value="+19493958551" target="_blank">(949) 395-8551
Follow me: @bmaso
[hidden email]

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.



--
Family photographs are a critical legacy for
ourselves and our descendants. Protect that
legacy with a digital backup and recovery plan.

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Scala Library Documentation

Eduardo Cavalcanti
In reply to this post by Eddy WM
Hi, Eddy,
 
I do not believe you will make great insight of the language focusing on the Scaladocs, although they are invaluable to know Scala library API.
As you already know Java maybe you will find "Scala for the impatient" by Cay Horstmann to be useful.
There are several good Scala books and using Google you can find good explanations on several issues of the language.
I like "Programming Scala, 2nd Edition" by Dean Wampler. Very nice reading.
Cheers.




De: [hidden email]
Enviada: Quinta-feira, 16 de Fevereiro de 2017 17:11
Para: [hidden email]
Assunto: [scala-user] Scala Library Documentation

Hey fellows scala devs

I'm new to scala world, I have been writing codes for long time in Java, JavaScript and PHP. I have developed several business applications like web apps using both PHP and Java, Android applications, rich client applications ,...
I started last month to learn Scala after having made some inquiries on the language and the community behind the language.
Since I have learning the language I have realised that in the Scala Library the classes are not documented, as a  long time Java developer I used to dig into the jdk , read what the library designers wrote about the jdk classes , methods and fields and I mostly ended up finding the why of many classes and methods just by looking at their codes. 
For me it's just impossible to read the codes in the Scala Library, the codes are condensed and there is nothing like comment in any of the class, I may want to understand the implementation of a given data struture but nothing is given as documentation in the library for someone to understand.

 

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-user+unsubscribe@....
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: Scala Library Documentation

Martijn Hoekstra
In reply to this post by Eddy WM
I presonally find much of the stdlib fairly easy to read. I'm not sure what the "average" jdk class looks like, but I cracked open a random class, and I can't really say that something like http://www.docjar.com/html/api/java/text/ChoiceFormat.java.html  is much better documented with code comments than the scala stdlib.

You indicate that you're new to the scala world, so it's not unreasonable to assume it's going to take you a bit more effort reading scala code, than reading code in a language you know very well already. When you acquire some more experience, you may find that what you consider unreadable condensed now, you find clear and concise later. 


On Fri, Feb 17, 2017 at 2:11 AM, Eddy WM <[hidden email]> wrote:
Hey fellows scala devs

I'm new to scala world, I have been writing codes for long time in Java, JavaScript and PHP. I have developed several business applications like web apps using both PHP and Java, Android applications, rich client applications ,...
I started last month to learn Scala after having made some inquiries on the language and the community behind the language.
Since I have learning the language I have realised that in the Scala Library the classes are not documented, as a  long time Java developer I used to dig into the jdk , read what the library designers wrote about the jdk classes , methods and fields and I mostly ended up finding the why of many classes and methods just by looking at their codes. 
For me it's just impossible to read the codes in the Scala Library, the codes are condensed and there is nothing like comment in any of the class, I may want to understand the implementation of a given data struture but nothing is given as documentation in the library for someone to understand.

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.