Have a look at the Spec video by Johan Fabry during the Pharo days on youtube. Le 23/9/16 à 23:32, julius a écrit :
Thanks for you answers!
I'm aware of the books on the pharo.org/documentation page. But for me that is not sufficient. I'm currently playing around while programming my fist own and unguided application. It will be quite simple, just a reminder application where notes can be added, removed, edited and all of them should trigger a notification when they are due. I plan to save all notes in a SQLite database, display is done with spec.
I'm interested by your result. It will be a nice example.
While this is basic stuff I often have to go into the source and search for the correct messages to send and to see what kind of return objects I get. For example I wanted to use a SortedCollection as data structure for my notes (consisting of a string and a date) that should be ordered by date, so since this is not really described in the Pharo by Example book I looked at the implementation and searched online
It would be definitely better to just have only or in the image a full documentation for SortedCollection which links to a full documentation of OrderedCollection. This is call a class :). Now may be the class comments should be improved. I have to confess I didn't read Pharo in depth and Pharo for Enterpise yet but I also don't think its convenient to have all the books open and search there for documentation.
Since I think a full searchable documentation would be very helpful especially for beginners and I definitely would like to have one I would be happy to contribute. The books that are based on pillar are in pdf and html. In the past we got a pharodoc but it was just the pharo comments on the web so it was not really useful. Are there already some efforts toward it or does somebody has an idea how to accomplish that? Right now I imagine the best thing would be to have an automated workflow to read out the comments of the current release somehow and presenting them online. Maybe it would need to write a parser to get them well formatted (so that example code looks like code and so on). So if there is any way that I can contribute, I will do. Point us to the point you have problems and tell us what are the class comments that are poor. Finish your project and write a little chapter. This will really help.
The chapter does not have to be complete. Did you read the chapter of Sven on developing a reddit application in 10 classes? Because having something like that with your project would be great and I can participate if you want.
Best, Julius
-- View this message in context: http://forum.world.st/Essential-Documentation-tp4916861p4916904.html Sent from the Pharo Smalltalk Users mailing list archive at Nabble.com.