I was pointed out yesterday to scodec for #scala. It has some important things there that seem very useful and will likely use it.
It's just pretty sad that such a known, useful, stable library has most of the site with incomplete docs, broken links and incomplete released version numbers.
Example:
- incomplete docs: from this on scodec.org/guide/Collections.h…
- scodec.org/api/ scodec-protocols 1.2.0 link broken; versions on the page are not latest and you need to check github
🫣
This entry was edited (10 months ago)
vascorsd
in reply to vascorsd • • •But don't misunderstand me, this site has better docs than 98% of any other scala library out there.
It's quite good for what is there.
I just spend some time reading the first pages of the guide and I really like the explanations for the data structures, what they mean, why and when you should use them, etc
So, this is good 💪
But we can surely make it better 😌
vascorsd
in reply to vascorsd • • •This library is better than official scala docs where I spent some hours the other day navigating the confusion of some Collections trying to understand the different ways I could create an ordered Map and basically giving up on the idea because I was unsure of what I should use.
I mean I eventually got the information I wanted, but it was from jumping between google, stack overflow, scala main page and a bunch of api docs.
But it didn't left with with any confidence for what I was doing.
😮💨
vascorsd
in reply to vascorsd • • •In general the official #scala API docs are very very lacking and generally suck.
Methods have barely any description on them. There are no examples in most methods to understand them. Important methods and collections lack explanation of their characteristics related to performance, runtime, O notations of each etc. Barely describe where each is more appropriate vs others, etc.
🫣
davesmith00000
in reply to vascorsd • • •Rui Batista
in reply to davesmith00000 • • •vascorsd
in reply to Rui Batista • • •@ragb @davesmith00000 I know that scaladoc before the scala 3 was not the prettiest or easy to navigate, but I'm not sure if the improvements for the new scaladoc are good enough besides it just having a newer theme. Which in my opinion is not really much better than the previous one, at least I find it pretty hard to read compared to the previous version.
What features/changes would make it better?
Rui Batista
in reply to vascorsd • • •